Microsoft.Web (stable:2016-08-01)

2025/09/30 • 311 new, 311 deleted methods

WebApps_List (new)
Description Get all apps for a subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListByResourceGroup (new)
Description Gets all web, mobile, and API apps in the specified resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites
{
resourceGroupName: string ,
includeSlots: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_Get (new)
Description Gets the details of a web, mobile, or API app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateOrUpdate (new)
Description Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName: string ,
name: string ,
siteEnvelope:
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (202)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
WebApps_Delete (new)
Description Deletes a web, mobile, or API app, or one of the deployment slots.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName: string ,
name: string ,
deleteMetrics: boolean ,
deleteEmptyServerFarm: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_Update (new)
Description Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName: string ,
name: string ,
siteEnvelope:
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (202)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
WebApps_AnalyzeCustomHostname (new)
Description Analyze a custom hostname.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname
{
resourceGroupName: string ,
name: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isHostnameAlreadyVerified: boolean ,
customDomainVerificationTest: enum ,
customDomainVerificationFailureInfo:
{
extendedCode: string ,
messageTemplate: string ,
parameters:
[
string ,
]
,
innerErrors:
[
string ,
]
,
code: string ,
message: string ,
}
,
hasConflictOnScaleUnit: boolean ,
hasConflictAcrossSubscription: boolean ,
conflictingAppResourceId: string ,
cNameRecords:
[
string ,
]
,
txtRecords:
[
string ,
]
,
aRecords:
[
string ,
]
,
alternateCNameRecords:
[
string ,
]
,
alternateTxtRecords:
[
string ,
]
,
}
,
}
WebApps_ApplySlotConfigToProduction (new)
Description Applies the configuration settings from the target slot onto the current slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_Backup (new)
Description Creates a backup of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_ListBackups (new)
Description Gets existing backups of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_DiscoverRestore (new)
Description Discovers an existing app backup that can be restored from a blob in Azure storage.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
WebApps_GetBackupStatus (new)
Description Gets a backup of an app by its ID.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}
{
resourceGroupName: string ,
name: string ,
backupId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_DeleteBackup (new)
Description Deletes a backup of an app by its ID.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}
{
resourceGroupName: string ,
name: string ,
backupId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListBackupStatusSecrets (new)
Description 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.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list
{
resourceGroupName: string ,
name: string ,
backupId: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_Restore (new)
Description Restores a specific backup to another app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore
{
resourceGroupName: string ,
name: string ,
backupId: string ,
request:
{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
operationId: string ,
}
,
}
WebApps_ListConfigurations (new)
Description List the configurations of an app
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_UpdateApplicationSettings (new)
Description Replaces the application settings of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings
{
resourceGroupName: string ,
name: string ,
appSettings:
{
properties: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListApplicationSettings (new)
Description Gets the application settings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_UpdateAuthSettings (new)
Description Updates the Authentication / Authorization settings associated with web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings
{
resourceGroupName: string ,
name: string ,
siteAuthSettings:
{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
WebApps_GetAuthSettings (new)
Description Gets the Authentication/Authorization settings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
WebApps_UpdateBackupConfiguration (new)
Description Updates the backup configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
WebApps_DeleteBackupConfiguration (new)
Description Deletes the backup configuration of an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_GetBackupConfiguration (new)
Description Gets the backup configuration of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
WebApps_UpdateConnectionStrings (new)
Description Replaces the connection strings of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings
{
resourceGroupName: string ,
name: string ,
connectionStrings:
{
properties: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListConnectionStrings (new)
Description Gets the connection strings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_GetDiagnosticLogsConfiguration (new)
Description Gets the logging configuration of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
WebApps_UpdateDiagnosticLogsConfig (new)
Description Updates the logging configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName: string ,
name: string ,
siteLogsConfig:
{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
WebApps_UpdateMetadata (new)
Description Replaces the metadata of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata
{
resourceGroupName: string ,
name: string ,
metadata:
{
properties: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListMetadata (new)
Description Gets the metadata of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListPublishingCredentials (new)
Description Gets the Git/FTP publishing credentials of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
publishingUserName: string ,
publishingPassword: string ,
publishingPasswordHash: string ,
publishingPasswordHashSalt: string ,
}
,
}
WebApps_UpdateSitePushSettings (new)
Description Updates the Push settings associated with web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings
{
resourceGroupName: string ,
name: string ,
pushSettings:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
WebApps_ListSitePushSettings (new)
Description Gets the Push settings associated with web app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
WebApps_ListSlotConfigurationNames (new)
Description Gets the names of app settings and connection strings that stick to the slot (not swapped).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
connectionStringNames:
[
string ,
]
,
appSettingNames:
[
string ,
]
,
}
,
}
WebApps_UpdateSlotConfigurationNames (new)
Description Updates the names of application settings and connection string that remain with the slot during swap operation.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames
{
resourceGroupName: string ,
name: string ,
slotConfigNames:
{
properties:
{
connectionStringNames:
[
string ,
]
,
appSettingNames:
[
string ,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
connectionStringNames:
[
string ,
]
,
appSettingNames:
[
string ,
]
,
}
,
}
WebApps_GetConfiguration (new)
Description Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_CreateOrUpdateConfiguration (new)
Description Updates the configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName: string ,
name: string ,
siteConfig:
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_UpdateConfiguration (new)
Description Updates the configuration of an app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName: string ,
name: string ,
siteConfig:
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_ListConfigurationSnapshotInfo (new)
Description Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
time: string ,
id: integer ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetConfigurationSnapshot (new)
Description Gets a snapshot of the configuration of an app at a previous point in time.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}
{
resourceGroupName: string ,
name: string ,
snapshotId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_RecoverSiteConfigurationSnapshot (new)
Description Reverts the configuration of an app to a previous snapshot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover
{
resourceGroupName: string ,
name: string ,
snapshotId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}
WebApps_GetWebSiteContainerLogs (new)
Description Gets the last lines of docker logs for the given site
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}
WebApps_GetWebSiteContainerLogsZip (new)
Description Gets the ZIP archived docker log files for the given site
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}
WebApps_ListContinuousWebJobs (new)
Description List continuous web jobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
status: enum ,
detailedStatus: string ,
logUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetContinuousWebJob (new)
Description Gets a continuous web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
status: enum ,
detailedStatus: string ,
logUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteContinuousWebJob (new)
Description Delete a continuous web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_StartContinuousWebJob (new)
Description Start a continuous web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_StopContinuousWebJob (new)
Description Stop a continuous web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListDeployments (new)
Description List deployments for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetDeployment (new)
Description Get a deployment by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_CreateDeployment (new)
Description Create a deployment for an app, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
deployment:
{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_DeleteDeployment (new)
Description Delete a deployment by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListDeploymentLog (new)
Description List deployment log for specific deployment for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log
{
resourceGroupName: string ,
name: string ,
id: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_ListDomainOwnershipIdentifiers (new)
Description Lists ownership identifiers for domain associated with web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetDomainOwnershipIdentifier (new)
Description Get domain ownership identifier for web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_CreateOrUpdateDomainOwnershipIdentifier (new)
Description Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
domainOwnershipIdentifier:
{
properties:
{
id: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_DeleteDomainOwnershipIdentifier (new)
Description Deletes a domain ownership identifier for a web app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_UpdateDomainOwnershipIdentifier (new)
Description Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
domainOwnershipIdentifier:
{
properties:
{
id: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_GetMSDeployStatus (new)
Description Get the status of the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}
WebApps_CreateMSDeployOperation (new)
Description Invoke the MSDeploy web app extension.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
MSDeploy:
{
properties:
{
addOnPackages:
[
{
packageUri: string ,
connectionString: string ,
dbType: string ,
setParametersXmlFileUri: string ,
setParameters: object ,
skipAppData: boolean ,
appOffline: boolean ,
}
,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}

⚐ Response (409)

{}
WebApps_GetMSDeployLog (new)
Description Get the MSDeploy Log for the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entries:
[
{
time: string ,
type: enum ,
message: string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_ListFunctions (new)
Description List the functions for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetFunctionsAdminToken (new)
Description Fetch a short lived token that can be exchanged for a master key.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_GetFunction (new)
Description Get function information by its ID for web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateFunction (new)
Description Create function for web site, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
function_envelope:
{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
WebApps_DeleteFunction (new)
Description Delete a function for web site, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_ListFunctionSecrets (new)
Description Get function secrets for a function in a web site, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets
{
resourceGroupName: string ,
name: string ,
functionName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
key: string ,
triggerUrl: string ,
}
,
}
WebApps_ListHostNameBindings (new)
Description Get hostname bindings for an app or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetHostNameBinding (new)
Description Get the named hostname binding for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
WebApps_CreateOrUpdateHostNameBinding (new)
Description Creates a hostname binding for an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
hostName: string ,
hostNameBinding:
{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
WebApps_DeleteHostNameBinding (new)
Description Deletes a hostname binding for an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_GetHybridConnection (new)
Description Retrieves a specific Service Bus Hybrid Connection used by this Web App.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_CreateOrUpdateHybridConnection (new)
Description Creates a new Hybrid Connection using a Service Bus relay.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
connectionEnvelope:
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_DeleteHybridConnection (new)
Description Removes a Hybrid Connection from this site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateHybridConnection (new)
Description Creates a new Hybrid Connection using a Service Bus relay.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
connectionEnvelope:
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_ListHybridConnectionKeys (new)
Description Gets the send key name and value for a Hybrid Connection.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sendKeyName: string ,
sendKeyValue: string ,
}
,
}
WebApps_ListHybridConnections (new)
Description Retrieves all Service Bus Hybrid Connections used by this Web App.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_ListRelayServiceConnections (new)
Description Gets hybrid connections configured for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_GetRelayServiceConnection (new)
Description Gets a hybrid connection configuration by its name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_CreateOrUpdateRelayServiceConnection (new)
Description Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
connectionEnvelope:
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_DeleteRelayServiceConnection (new)
Description Deletes a relay service connection by its name.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateRelayServiceConnection (new)
Description Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
connectionEnvelope:
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_ListInstanceIdentifiers (new)
Description Gets all scale-out instances of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetInstanceMsDeployStatus (new)
Description Get the status of the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}
WebApps_CreateInstanceMSDeployOperation (new)
Description Invoke the MSDeploy web app extension.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
instanceId: string ,
MSDeploy:
{
properties:
{
addOnPackages:
[
{
packageUri: string ,
connectionString: string ,
dbType: string ,
setParametersXmlFileUri: string ,
setParameters: object ,
skipAppData: boolean ,
appOffline: boolean ,
}
,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}

⚐ Response (409)

{}
WebApps_GetInstanceMSDeployLog (new)
Description Get the MSDeploy Log for the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log
{
resourceGroupName: string ,
name: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entries:
[
{
time: string ,
type: enum ,
message: string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcesses (new)
Description Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes
{
resourceGroupName: string ,
name: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcess (new)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteInstanceProcess (new)
Description Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_GetInstanceProcessDump (new)
Description Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessModules (new)
Description List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessModule (new)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName: string ,
name: string ,
processId: string ,
baseAddress: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessThreads (new)
Description List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessThread (new)
Description Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads/{threadId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
threadId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}

⚐ Response (404)

{}
WebApps_IsCloneable (new)
Description Shows whether an app can be cloned to another resource group or subscription.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
result: enum ,
blockingFeatures:
[
{
name: string ,
description: string ,
}
,
]
,
unsupportedFeatures:
[
{
name: string ,
description: string ,
}
,
]
,
blockingCharacteristics:
[
{
name: string ,
description: string ,
}
,
]
,
}
WebApps_ListSyncFunctionTriggers (new)
Description This is to allow calling via powershell and ARM template.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
key: string ,
triggerUrl: string ,
}
,
}
WebApps_ListMetricDefinitions (new)
Description Gets all metric definitions of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name:
{
value: string ,
localizedValue: string ,
}
,
unit: string ,
primaryAggregationType: string ,
metricAvailabilities:
[
{
timeGrain: string ,
retention: string ,
}
,
]
,
resourceUri: string ,
id: string ,
properties: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListMetrics (new)
Description Gets performance metrics of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics
{
resourceGroupName: string ,
name: string ,
details: boolean ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name:
{
value: string ,
localizedValue: string ,
}
,
unit: string ,
timeGrain: string ,
startTime: string ,
endTime: string ,
resourceId: string ,
id: string ,
metricValues:
[
{
timestamp: string ,
average: number ,
minimum: number ,
maximum: number ,
total: number ,
count: number ,
properties:
[
{
key: string ,
value: string ,
}
,
]
,
}
,
]
,
properties:
[
{
key: string ,
value: string ,
}
,
]
,
}
,
]
,
nextLink: string ,
}
WebApps_MigrateStorage (new)
Description Restores a web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate
{
subscriptionName: string ,
resourceGroupName: string ,
name: string ,
migrationOptions:
{
properties:
{
azurefilesConnectionString: string ,
azurefilesShare: string ,
switchSiteAfterMigration: boolean ,
blockWriteAccessToSite: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
operationId: string ,
}
,
}
WebApps_MigrateMySql (new)
Description Migrates a local (in-app) MySql database to a remote MySql database.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql
{
resourceGroupName: string ,
name: string ,
migrationRequestEnvelope:
{
properties:
{
connectionString: string ,
migrationType: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
status: enum ,
errors:
[
{
extendedCode: string ,
messageTemplate: string ,
parameters:
[
string ,
]
,
innerErrors:
[
string ,
]
,
code: string ,
message: string ,
}
,
]
,
createdTime: string ,
modifiedTime: string ,
expirationTime: string ,
geoMasterOperationId: string ,
}
WebApps_GetMigrateMySqlStatus (new)
Description Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
migrationOperationStatus: enum ,
operationId: string ,
localMySqlEnabled: boolean ,
}
,
}
WebApps_ListNetworkFeatures (new)
Description Gets all network features used by the app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}
{
resourceGroupName: string ,
name: string ,
view: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
virtualNetworkName: string ,
virtualNetworkConnection:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
hybridConnections:
[
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
]
,
hybridConnectionsV2:
[
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_StartWebSiteNetworkTrace (new)
Description Start capturing network packets for the site.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start
{
resourceGroupName: string ,
name: string ,
durationInSeconds: integer ,
maxFrameLength: integer ,
sasUrl: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_StopWebSiteNetworkTrace (new)
Description Stop ongoing capturing network packets for the site.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_GenerateNewSitePublishingPassword (new)
Description Generates a new publishing password for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListPerfMonCounters (new)
Description Gets perfmon counters for web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters
{
resourceGroupName: string ,
name: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
code: string ,
message: string ,
data:
{
name: string ,
startTime: string ,
endTime: string ,
timeGrain: string ,
values:
[
{
time: string ,
instanceName: string ,
value: number ,
coreCount: integer ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSitePhpErrorLogFlag (new)
Description Gets web app's event logs.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
localLogErrors: string ,
masterLogErrors: string ,
localLogErrorsMaxLength: string ,
masterLogErrorsMaxLength: string ,
}
,
}
WebApps_ListPremierAddOns (new)
Description Gets the premier add-ons of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_GetPremierAddOn (new)
Description Gets a named add-on of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_AddPremierAddOn (new)
Description Updates a named add-on of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
premierAddOn:
{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_DeletePremierAddOn (new)
Description Delete a premier add-on from an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_ListProcesses (new)
Description Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcess (new)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteProcess (new)
Description Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_GetProcessDump (new)
Description Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (404)

{}
WebApps_ListProcessModules (new)
Description List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessModule (new)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName: string ,
name: string ,
processId: string ,
baseAddress: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListProcessThreads (new)
Description List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessThread (new)
Description Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads/{threadId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
threadId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListPublicCertificates (new)
Description Get public certificates for an app or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetPublicCertificate (new)
Description Get the named public certificate for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
publicCertificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
WebApps_CreateOrUpdatePublicCertificate (new)
Description Creates a hostname binding for an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
publicCertificateName: string ,
publicCertificate:
{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
WebApps_DeletePublicCertificate (new)
Description Deletes a hostname binding for an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
publicCertificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListPublishingProfileXmlWithSecrets (new)
Description Gets the publishing profile for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml
{
resourceGroupName: string ,
name: string ,
publishingProfileOptions:
{
format: enum ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}
WebApps_Recover (new)
Description Recovers a web app to a previous snapshot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover
{
resourceGroupName: string ,
name: string ,
recoveryEntity:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}
WebApps_ResetProductionSlotConfig (new)
Description Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_Restart (new)
Description Restarts an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart
{
resourceGroupName: string ,
name: string ,
softRestart: boolean ,
synchronous: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_ListSiteExtensions (new)
Description Get list of site extensions for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetSiteExtension (new)
Description Get site extension information by its ID for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (404)

{}
WebApps_InstallSiteExtension (new)
Description Install site extension on a web site, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (200)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (429)

{}
WebApps_DeleteSiteExtension (new)
Description Remove a site extension from a web site, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_ListSlots (new)
Description Gets an app's deployment slots.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSlot (new)
Description Gets the details of a web, mobile, or API app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateOrUpdateSlot (new)
Description Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName: string ,
name: string ,
siteEnvelope:
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
slot: string ,
skipDnsRegistration: boolean ,
skipCustomDomainVerification: boolean ,
forceDnsRegistration: boolean ,
ttlInSeconds: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (202)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
WebApps_DeleteSlot (new)
Description Deletes a web, mobile, or API app, or one of the deployment slots.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName: string ,
name: string ,
slot: string ,
deleteMetrics: boolean ,
deleteEmptyServerFarm: boolean ,
skipDnsRegistration: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_UpdateSlot (new)
Description Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName: string ,
name: string ,
siteEnvelope:
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
}
,
slot: string ,
skipDnsRegistration: boolean ,
skipCustomDomainVerification: boolean ,
forceDnsRegistration: boolean ,
ttlInSeconds: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (202)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
WebApps_AnalyzeCustomHostnameSlot (new)
Description Analyze a custom hostname.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname
{
resourceGroupName: string ,
name: string ,
slot: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isHostnameAlreadyVerified: boolean ,
customDomainVerificationTest: enum ,
customDomainVerificationFailureInfo:
{
extendedCode: string ,
messageTemplate: string ,
parameters:
[
string ,
]
,
innerErrors:
[
string ,
]
,
code: string ,
message: string ,
}
,
hasConflictOnScaleUnit: boolean ,
hasConflictAcrossSubscription: boolean ,
conflictingAppResourceId: string ,
cNameRecords:
[
string ,
]
,
txtRecords:
[
string ,
]
,
aRecords:
[
string ,
]
,
alternateCNameRecords:
[
string ,
]
,
alternateTxtRecords:
[
string ,
]
,
}
,
}
WebApps_ApplySlotConfigurationSlot (new)
Description Applies the configuration settings from the target slot onto the current slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_BackupSlot (new)
Description Creates a backup of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_ListBackupsSlot (new)
Description Gets existing backups of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_DiscoverRestoreSlot (new)
Description Discovers an existing app backup that can be restored from a blob in Azure storage.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
WebApps_GetBackupStatusSlot (new)
Description Gets a backup of an app by its ID.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName: string ,
name: string ,
backupId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_DeleteBackupSlot (new)
Description Deletes a backup of an app by its ID.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName: string ,
name: string ,
backupId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListBackupStatusSecretsSlot (new)
Description 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.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list
{
resourceGroupName: string ,
name: string ,
backupId: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_RestoreSlot (new)
Description Restores a specific backup to another app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore
{
resourceGroupName: string ,
name: string ,
backupId: string ,
request:
{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
operationId: string ,
}
,
}
WebApps_ListConfigurationsSlot (new)
Description List the configurations of an app
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_UpdateApplicationSettingsSlot (new)
Description Replaces the application settings of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings
{
resourceGroupName: string ,
name: string ,
appSettings:
{
properties: object ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListApplicationSettingsSlot (new)
Description Gets the application settings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_UpdateAuthSettingsSlot (new)
Description Updates the Authentication / Authorization settings associated with web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings
{
resourceGroupName: string ,
name: string ,
siteAuthSettings:
{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
WebApps_GetAuthSettingsSlot (new)
Description Gets the Authentication/Authorization settings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
WebApps_UpdateBackupConfigurationSlot (new)
Description Updates the backup configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
WebApps_DeleteBackupConfigurationSlot (new)
Description Deletes the backup configuration of an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_GetBackupConfigurationSlot (new)
Description Gets the backup configuration of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
WebApps_UpdateConnectionStringsSlot (new)
Description Replaces the connection strings of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings
{
resourceGroupName: string ,
name: string ,
connectionStrings:
{
properties: object ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListConnectionStringsSlot (new)
Description Gets the connection strings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_GetDiagnosticLogsConfigurationSlot (new)
Description Gets the logging configuration of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
WebApps_UpdateDiagnosticLogsConfigSlot (new)
Description Updates the logging configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName: string ,
name: string ,
siteLogsConfig:
{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
WebApps_UpdateMetadataSlot (new)
Description Replaces the metadata of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata
{
resourceGroupName: string ,
name: string ,
metadata:
{
properties: object ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListMetadataSlot (new)
Description Gets the metadata of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListPublishingCredentialsSlot (new)
Description Gets the Git/FTP publishing credentials of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
publishingUserName: string ,
publishingPassword: string ,
publishingPasswordHash: string ,
publishingPasswordHashSalt: string ,
}
,
}
WebApps_UpdateSitePushSettingsSlot (new)
Description Updates the Push settings associated with web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings
{
resourceGroupName: string ,
name: string ,
pushSettings:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
WebApps_ListSitePushSettingsSlot (new)
Description Gets the Push settings associated with web app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
WebApps_GetConfigurationSlot (new)
Description Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_CreateOrUpdateConfigurationSlot (new)
Description Updates the configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName: string ,
name: string ,
siteConfig:
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_UpdateConfigurationSlot (new)
Description Updates the configuration of an app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName: string ,
name: string ,
siteConfig:
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_ListConfigurationSnapshotInfoSlot (new)
Description Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
time: string ,
id: integer ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetConfigurationSnapshotSlot (new)
Description Gets a snapshot of the configuration of an app at a previous point in time.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}
{
resourceGroupName: string ,
name: string ,
snapshotId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_RecoverSiteConfigurationSnapshotSlot (new)
Description Reverts the configuration of an app to a previous snapshot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover
{
resourceGroupName: string ,
name: string ,
snapshotId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}
WebApps_GetWebSiteContainerLogsSlot (new)
Description Gets the last lines of docker logs for the given site
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}
WebApps_GetWebSiteContainerLogsZipSlot (new)
Description Gets the ZIP archived docker log files for the given site
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}
WebApps_ListContinuousWebJobsSlot (new)
Description List continuous web jobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
status: enum ,
detailedStatus: string ,
logUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetContinuousWebJobSlot (new)
Description Gets a continuous web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
status: enum ,
detailedStatus: string ,
logUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteContinuousWebJobSlot (new)
Description Delete a continuous web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_StartContinuousWebJobSlot (new)
Description Start a continuous web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_StopContinuousWebJobSlot (new)
Description Stop a continuous web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListDeploymentsSlot (new)
Description List deployments for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetDeploymentSlot (new)
Description Get a deployment by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_CreateDeploymentSlot (new)
Description Create a deployment for an app, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
slot: string ,
deployment:
{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_DeleteDeploymentSlot (new)
Description Delete a deployment by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListDeploymentLogSlot (new)
Description List deployment log for specific deployment for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log
{
resourceGroupName: string ,
name: string ,
id: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_ListDomainOwnershipIdentifiersSlot (new)
Description Lists ownership identifiers for domain associated with web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetDomainOwnershipIdentifierSlot (new)
Description Get domain ownership identifier for web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot (new)
Description Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
domainOwnershipIdentifier:
{
properties:
{
id: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_DeleteDomainOwnershipIdentifierSlot (new)
Description Deletes a domain ownership identifier for a web app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_UpdateDomainOwnershipIdentifierSlot (new)
Description Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
domainOwnershipIdentifier:
{
properties:
{
id: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_GetMSDeployStatusSlot (new)
Description Get the status of the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}
WebApps_CreateMSDeployOperationSlot (new)
Description Invoke the MSDeploy web app extension.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
slot: string ,
MSDeploy:
{
properties:
{
addOnPackages:
[
{
packageUri: string ,
connectionString: string ,
dbType: string ,
setParametersXmlFileUri: string ,
setParameters: object ,
skipAppData: boolean ,
appOffline: boolean ,
}
,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}

⚐ Response (409)

{}
WebApps_GetMSDeployLogSlot (new)
Description Get the MSDeploy Log for the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entries:
[
{
time: string ,
type: enum ,
message: string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceFunctionsSlot (new)
Description List the functions for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetFunctionsAdminTokenSlot (new)
Description Fetch a short lived token that can be exchanged for a master key.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_GetInstanceFunctionSlot (new)
Description Get function information by its ID for web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateInstanceFunctionSlot (new)
Description Create function for web site, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
slot: string ,
function_envelope:
{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
WebApps_DeleteInstanceFunctionSlot (new)
Description Delete a function for web site, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_ListFunctionSecretsSlot (new)
Description Get function secrets for a function in a web site, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets
{
resourceGroupName: string ,
name: string ,
functionName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
key: string ,
triggerUrl: string ,
}
,
}
WebApps_ListHostNameBindingsSlot (new)
Description Get hostname bindings for an app or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetHostNameBindingSlot (new)
Description Get the named hostname binding for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
slot: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
WebApps_CreateOrUpdateHostNameBindingSlot (new)
Description Creates a hostname binding for an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
hostName: string ,
hostNameBinding:
{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
WebApps_DeleteHostNameBindingSlot (new)
Description Deletes a hostname binding for an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
slot: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_GetHybridConnectionSlot (new)
Description Retrieves a specific Service Bus Hybrid Connection used by this Web App.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_CreateOrUpdateHybridConnectionSlot (new)
Description Creates a new Hybrid Connection using a Service Bus relay.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
connectionEnvelope:
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_DeleteHybridConnectionSlot (new)
Description Removes a Hybrid Connection from this site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateHybridConnectionSlot (new)
Description Creates a new Hybrid Connection using a Service Bus relay.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
connectionEnvelope:
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_ListHybridConnectionKeysSlot (new)
Description Gets the send key name and value for a Hybrid Connection.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sendKeyName: string ,
sendKeyValue: string ,
}
,
}
WebApps_ListHybridConnectionsSlot (new)
Description Retrieves all Service Bus Hybrid Connections used by this Web App.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_ListRelayServiceConnectionsSlot (new)
Description Gets hybrid connections configured for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_GetRelayServiceConnectionSlot (new)
Description Gets a hybrid connection configuration by its name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_CreateOrUpdateRelayServiceConnectionSlot (new)
Description Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
connectionEnvelope:
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_DeleteRelayServiceConnectionSlot (new)
Description Deletes a relay service connection by its name.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateRelayServiceConnectionSlot (new)
Description Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
connectionEnvelope:
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_ListInstanceIdentifiersSlot (new)
Description Gets all scale-out instances of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetInstanceMsDeployStatusSlot (new)
Description Get the status of the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}
WebApps_CreateInstanceMSDeployOperationSlot (new)
Description Invoke the MSDeploy web app extension.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
slot: string ,
instanceId: string ,
MSDeploy:
{
properties:
{
addOnPackages:
[
{
packageUri: string ,
connectionString: string ,
dbType: string ,
setParametersXmlFileUri: string ,
setParameters: object ,
skipAppData: boolean ,
appOffline: boolean ,
}
,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}

⚐ Response (409)

{}
WebApps_GetInstanceMSDeployLogSlot (new)
Description Get the MSDeploy Log for the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log
{
resourceGroupName: string ,
name: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entries:
[
{
time: string ,
type: enum ,
message: string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessesSlot (new)
Description Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes
{
resourceGroupName: string ,
name: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessSlot (new)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteInstanceProcessSlot (new)
Description Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_GetInstanceProcessDumpSlot (new)
Description Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessModulesSlot (new)
Description List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessModuleSlot (new)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName: string ,
name: string ,
processId: string ,
baseAddress: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessThreadsSlot (new)
Description List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessThreadSlot (new)
Description Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads/{threadId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
threadId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}

⚐ Response (404)

{}
WebApps_IsCloneableSlot (new)
Description Shows whether an app can be cloned to another resource group or subscription.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
result: enum ,
blockingFeatures:
[
{
name: string ,
description: string ,
}
,
]
,
unsupportedFeatures:
[
{
name: string ,
description: string ,
}
,
]
,
blockingCharacteristics:
[
{
name: string ,
description: string ,
}
,
]
,
}
WebApps_ListSyncFunctionTriggersSlot (new)
Description This is to allow calling via powershell and ARM template.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
key: string ,
triggerUrl: string ,
}
,
}
WebApps_ListMetricDefinitionsSlot (new)
Description Gets all metric definitions of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name:
{
value: string ,
localizedValue: string ,
}
,
unit: string ,
primaryAggregationType: string ,
metricAvailabilities:
[
{
timeGrain: string ,
retention: string ,
}
,
]
,
resourceUri: string ,
id: string ,
properties: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListMetricsSlot (new)
Description Gets performance metrics of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics
{
resourceGroupName: string ,
name: string ,
slot: string ,
details: boolean ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name:
{
value: string ,
localizedValue: string ,
}
,
unit: string ,
timeGrain: string ,
startTime: string ,
endTime: string ,
resourceId: string ,
id: string ,
metricValues:
[
{
timestamp: string ,
average: number ,
minimum: number ,
maximum: number ,
total: number ,
count: number ,
properties:
[
{
key: string ,
value: string ,
}
,
]
,
}
,
]
,
properties:
[
{
key: string ,
value: string ,
}
,
]
,
}
,
]
,
nextLink: string ,
}
WebApps_GetMigrateMySqlStatusSlot (new)
Description Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
migrationOperationStatus: enum ,
operationId: string ,
localMySqlEnabled: boolean ,
}
,
}
WebApps_ListNetworkFeaturesSlot (new)
Description Gets all network features used by the app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}
{
resourceGroupName: string ,
name: string ,
view: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
virtualNetworkName: string ,
virtualNetworkConnection:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
hybridConnections:
[
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
]
,
hybridConnectionsV2:
[
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_StartWebSiteNetworkTraceSlot (new)
Description Start capturing network packets for the site.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start
{
resourceGroupName: string ,
name: string ,
durationInSeconds: integer ,
slot: string ,
maxFrameLength: integer ,
sasUrl: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_StopWebSiteNetworkTraceSlot (new)
Description Stop ongoing capturing network packets for the site.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_GenerateNewSitePublishingPasswordSlot (new)
Description Generates a new publishing password for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListPerfMonCountersSlot (new)
Description Gets perfmon counters for web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters
{
resourceGroupName: string ,
name: string ,
slot: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
code: string ,
message: string ,
data:
{
name: string ,
startTime: string ,
endTime: string ,
timeGrain: string ,
values:
[
{
time: string ,
instanceName: string ,
value: number ,
coreCount: integer ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSitePhpErrorLogFlagSlot (new)
Description Gets web app's event logs.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
localLogErrors: string ,
masterLogErrors: string ,
localLogErrorsMaxLength: string ,
masterLogErrorsMaxLength: string ,
}
,
}
WebApps_ListPremierAddOnsSlot (new)
Description Gets the premier add-ons of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_GetPremierAddOnSlot (new)
Description Gets a named add-on of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_AddPremierAddOnSlot (new)
Description Updates a named add-on of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
premierAddOn:
{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_DeletePremierAddOnSlot (new)
Description Delete a premier add-on from an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_ListProcessesSlot (new)
Description Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessSlot (new)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteProcessSlot (new)
Description Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_GetProcessDumpSlot (new)
Description Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (404)

{}
WebApps_ListProcessModulesSlot (new)
Description List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessModuleSlot (new)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName: string ,
name: string ,
processId: string ,
baseAddress: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListProcessThreadsSlot (new)
Description List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessThreadSlot (new)
Description Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads/{threadId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
threadId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListPublicCertificatesSlot (new)
Description Get public certificates for an app or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetPublicCertificateSlot (new)
Description Get the named public certificate for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
slot: string ,
publicCertificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
WebApps_CreateOrUpdatePublicCertificateSlot (new)
Description Creates a hostname binding for an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
publicCertificateName: string ,
publicCertificate:
{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
WebApps_DeletePublicCertificateSlot (new)
Description Deletes a hostname binding for an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
slot: string ,
publicCertificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListPublishingProfileXmlWithSecretsSlot (new)
Description Gets the publishing profile for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml
{
resourceGroupName: string ,
name: string ,
publishingProfileOptions:
{
format: enum ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}
WebApps_RecoverSlot (new)
Description Recovers a web app to a previous snapshot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover
{
resourceGroupName: string ,
name: string ,
recoveryEntity:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}
WebApps_ResetSlotConfigurationSlot (new)
Description Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_RestartSlot (new)
Description Restarts an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart
{
resourceGroupName: string ,
name: string ,
slot: string ,
softRestart: boolean ,
synchronous: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_ListSiteExtensionsSlot (new)
Description Get list of site extensions for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetSiteExtensionSlot (new)
Description Get site extension information by its ID for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (404)

{}
WebApps_InstallSiteExtensionSlot (new)
Description Install site extension on a web site, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (200)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (429)

{}
WebApps_DeleteSiteExtensionSlot (new)
Description Remove a site extension from a web site, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_ListSlotDifferencesSlot (new)
Description Get the difference in configuration settings between two web app slots.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
type: string ,
settingType: string ,
diffRule: string ,
settingName: string ,
valueInCurrentSlot: string ,
valueInTargetSlot: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_SwapSlotSlot (new)
Description Swaps two deployment slots of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
WebApps_ListSnapshotsSlot (new)
Description Returns all Snapshots to the user.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
time: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSourceControlSlot (new)
Description Gets the source control configuration of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_CreateOrUpdateSourceControlSlot (new)
Description Updates the source control configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
siteSourceControl:
{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_DeleteSourceControlSlot (new)
Description Deletes the source control configuration of an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (404)

{}
WebApps_UpdateSourceControlSlot (new)
Description Updates the source control configuration of an app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
siteSourceControl:
{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_StartSlot (new)
Description Starts an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_StopSlot (new)
Description Stops an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_SyncRepositorySlot (new)
Description Sync web app repository.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_SyncFunctionTriggersSlot (new)
Description Syncs function trigger metadata to the scale controller
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}
WebApps_ListTriggeredWebJobsSlot (new)
Description List triggered web jobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
latestRun:
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
historyUrl: string ,
schedulerLogsUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetTriggeredWebJobSlot (new)
Description Gets a triggered web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
latestRun:
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
historyUrl: string ,
schedulerLogsUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteTriggeredWebJobSlot (new)
Description Delete a triggered web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListTriggeredWebJobHistorySlot (new)
Description List a triggered web job's history for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
triggeredJobRuns:
[
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetTriggeredWebJobHistorySlot (new)
Description Gets a triggered web job's history by its ID for an app, , or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
id: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
triggeredJobRuns:
[
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_RunTriggeredWebJobSlot (new)
Description Run a triggered web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListUsagesSlot (new)
Description Gets the quota usage information of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages
{
resourceGroupName: string ,
name: string ,
slot: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
unit: string ,
nextResetTime: string ,
currentValue: integer ,
limit: integer ,
name:
{
value: string ,
localizedValue: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListVnetConnectionsSlot (new)
Description Gets the virtual networks the app (or deployment slot) is connected to.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_GetVnetConnectionSlot (new)
Description Gets a virtual network the app (or deployment slot) is connected to by name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_CreateOrUpdateVnetConnectionSlot (new)
Description Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
connectionEnvelope:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_DeleteVnetConnectionSlot (new)
Description Deletes a connection from an app (or deployment slot to a named virtual network.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateVnetConnectionSlot (new)
Description Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
connectionEnvelope:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_GetVnetConnectionGatewaySlot (new)
Description Gets an app's Virtual Network gateway.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateOrUpdateVnetConnectionGatewaySlot (new)
Description Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
connectionEnvelope:
{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
WebApps_UpdateVnetConnectionGatewaySlot (new)
Description Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
connectionEnvelope:
{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
WebApps_ListWebJobsSlot (new)
Description List webjobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetWebJobSlot (new)
Description Get webjob information for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
WebApps_ListSlotDifferencesFromProduction (new)
Description Get the difference in configuration settings between two web app slots.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
type: string ,
settingType: string ,
diffRule: string ,
settingName: string ,
valueInCurrentSlot: string ,
valueInTargetSlot: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_SwapSlotWithProduction (new)
Description Swaps two deployment slots of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
WebApps_ListSnapshots (new)
Description Returns all Snapshots to the user.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
time: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSourceControl (new)
Description Gets the source control configuration of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_CreateOrUpdateSourceControl (new)
Description Updates the source control configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
siteSourceControl:
{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_DeleteSourceControl (new)
Description Deletes the source control configuration of an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (404)

{}
WebApps_UpdateSourceControl (new)
Description Updates the source control configuration of an app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
siteSourceControl:
{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_Start (new)
Description Starts an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_Stop (new)
Description Stops an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_SyncRepository (new)
Description Sync web app repository.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_SyncFunctionTriggers (new)
Description Syncs function trigger metadata to the scale controller
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}
WebApps_ListTriggeredWebJobs (new)
Description List triggered web jobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
latestRun:
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
historyUrl: string ,
schedulerLogsUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetTriggeredWebJob (new)
Description Gets a triggered web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
latestRun:
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
historyUrl: string ,
schedulerLogsUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteTriggeredWebJob (new)
Description Delete a triggered web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListTriggeredWebJobHistory (new)
Description List a triggered web job's history for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
triggeredJobRuns:
[
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetTriggeredWebJobHistory (new)
Description Gets a triggered web job's history by its ID for an app, , or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
id: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
triggeredJobRuns:
[
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_RunTriggeredWebJob (new)
Description Run a triggered web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListUsages (new)
Description Gets the quota usage information of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages
{
resourceGroupName: string ,
name: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
unit: string ,
nextResetTime: string ,
currentValue: integer ,
limit: integer ,
name:
{
value: string ,
localizedValue: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListVnetConnections (new)
Description Gets the virtual networks the app (or deployment slot) is connected to.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_GetVnetConnection (new)
Description Gets a virtual network the app (or deployment slot) is connected to by name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_CreateOrUpdateVnetConnection (new)
Description Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
connectionEnvelope:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_DeleteVnetConnection (new)
Description Deletes a connection from an app (or deployment slot to a named virtual network.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateVnetConnection (new)
Description Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
connectionEnvelope:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_GetVnetConnectionGateway (new)
Description Gets an app's Virtual Network gateway.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateOrUpdateVnetConnectionGateway (new)
Description Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
connectionEnvelope:
{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
WebApps_UpdateVnetConnectionGateway (new)
Description Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
connectionEnvelope:
{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
WebApps_ListWebJobs (new)
Description List webjobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetWebJob (new)
Description Get webjob information for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
WebApps_List (removed)
Description Get all apps for a subscription.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListByResourceGroup (removed)
Description Gets all web, mobile, and API apps in the specified resource group.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites
{
resourceGroupName: string ,
includeSlots: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_Get (removed)
Description Gets the details of a web, mobile, or API app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateOrUpdate (removed)
Description Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName: string ,
name: string ,
siteEnvelope:
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (202)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
WebApps_Delete (removed)
Description Deletes a web, mobile, or API app, or one of the deployment slots.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName: string ,
name: string ,
deleteMetrics: boolean ,
deleteEmptyServerFarm: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_Update (removed)
Description Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}
{
resourceGroupName: string ,
name: string ,
siteEnvelope:
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (202)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
WebApps_AnalyzeCustomHostname (removed)
Description Analyze a custom hostname.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname
{
resourceGroupName: string ,
name: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isHostnameAlreadyVerified: boolean ,
customDomainVerificationTest: enum ,
customDomainVerificationFailureInfo:
{
extendedCode: string ,
messageTemplate: string ,
parameters:
[
string ,
]
,
innerErrors:
[
string ,
]
,
code: string ,
message: string ,
}
,
hasConflictOnScaleUnit: boolean ,
hasConflictAcrossSubscription: boolean ,
conflictingAppResourceId: string ,
cNameRecords:
[
string ,
]
,
txtRecords:
[
string ,
]
,
aRecords:
[
string ,
]
,
alternateCNameRecords:
[
string ,
]
,
alternateTxtRecords:
[
string ,
]
,
}
,
}
WebApps_ApplySlotConfigToProduction (removed)
Description Applies the configuration settings from the target slot onto the current slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_Backup (removed)
Description Creates a backup of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_ListBackups (removed)
Description Gets existing backups of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_DiscoverRestore (removed)
Description Discovers an existing app backup that can be restored from a blob in Azure storage.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/discover
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
WebApps_GetBackupStatus (removed)
Description Gets a backup of an app by its ID.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}
{
resourceGroupName: string ,
name: string ,
backupId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_DeleteBackup (removed)
Description Deletes a backup of an app by its ID.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}
{
resourceGroupName: string ,
name: string ,
backupId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListBackupStatusSecrets (removed)
Description 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.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list
{
resourceGroupName: string ,
name: string ,
backupId: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_Restore (removed)
Description Restores a specific backup to another app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore
{
resourceGroupName: string ,
name: string ,
backupId: string ,
request:
{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
operationId: string ,
}
,
}
WebApps_ListConfigurations (removed)
Description List the configurations of an app
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_UpdateApplicationSettings (removed)
Description Replaces the application settings of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings
{
resourceGroupName: string ,
name: string ,
appSettings:
{
properties: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListApplicationSettings (removed)
Description Gets the application settings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_UpdateAuthSettings (removed)
Description Updates the Authentication / Authorization settings associated with web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings
{
resourceGroupName: string ,
name: string ,
siteAuthSettings:
{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
WebApps_GetAuthSettings (removed)
Description Gets the Authentication/Authorization settings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
WebApps_UpdateBackupConfiguration (removed)
Description Updates the backup configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
WebApps_DeleteBackupConfiguration (removed)
Description Deletes the backup configuration of an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_GetBackupConfiguration (removed)
Description Gets the backup configuration of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
WebApps_UpdateConnectionStrings (removed)
Description Replaces the connection strings of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings
{
resourceGroupName: string ,
name: string ,
connectionStrings:
{
properties: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListConnectionStrings (removed)
Description Gets the connection strings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_GetDiagnosticLogsConfiguration (removed)
Description Gets the logging configuration of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
WebApps_UpdateDiagnosticLogsConfig (removed)
Description Updates the logging configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs
{
resourceGroupName: string ,
name: string ,
siteLogsConfig:
{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
WebApps_UpdateMetadata (removed)
Description Replaces the metadata of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata
{
resourceGroupName: string ,
name: string ,
metadata:
{
properties: object ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListMetadata (removed)
Description Gets the metadata of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListPublishingCredentials (removed)
Description Gets the Git/FTP publishing credentials of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
publishingUserName: string ,
publishingPassword: string ,
publishingPasswordHash: string ,
publishingPasswordHashSalt: string ,
}
,
}
WebApps_UpdateSitePushSettings (removed)
Description Updates the Push settings associated with web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings
{
resourceGroupName: string ,
name: string ,
pushSettings:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
WebApps_ListSitePushSettings (removed)
Description Gets the Push settings associated with web app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
WebApps_ListSlotConfigurationNames (removed)
Description Gets the names of app settings and connection strings that stick to the slot (not swapped).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
connectionStringNames:
[
string ,
]
,
appSettingNames:
[
string ,
]
,
}
,
}
WebApps_UpdateSlotConfigurationNames (removed)
Description Updates the names of application settings and connection string that remain with the slot during swap operation.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames
{
resourceGroupName: string ,
name: string ,
slotConfigNames:
{
properties:
{
connectionStringNames:
[
string ,
]
,
appSettingNames:
[
string ,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
connectionStringNames:
[
string ,
]
,
appSettingNames:
[
string ,
]
,
}
,
}
WebApps_GetConfiguration (removed)
Description Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_CreateOrUpdateConfiguration (removed)
Description Updates the configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName: string ,
name: string ,
siteConfig:
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_UpdateConfiguration (removed)
Description Updates the configuration of an app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web
{
resourceGroupName: string ,
name: string ,
siteConfig:
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_ListConfigurationSnapshotInfo (removed)
Description Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
time: string ,
id: integer ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetConfigurationSnapshot (removed)
Description Gets a snapshot of the configuration of an app at a previous point in time.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}
{
resourceGroupName: string ,
name: string ,
snapshotId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_RecoverSiteConfigurationSnapshot (removed)
Description Reverts the configuration of an app to a previous snapshot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover
{
resourceGroupName: string ,
name: string ,
snapshotId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}
WebApps_GetWebSiteContainerLogs (removed)
Description Gets the last lines of docker logs for the given site
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}
WebApps_GetWebSiteContainerLogsZip (removed)
Description Gets the ZIP archived docker log files for the given site
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}
WebApps_ListContinuousWebJobs (removed)
Description List continuous web jobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
status: enum ,
detailedStatus: string ,
logUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetContinuousWebJob (removed)
Description Gets a continuous web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
status: enum ,
detailedStatus: string ,
logUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteContinuousWebJob (removed)
Description Delete a continuous web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_StartContinuousWebJob (removed)
Description Start a continuous web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_StopContinuousWebJob (removed)
Description Stop a continuous web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListDeployments (removed)
Description List deployments for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetDeployment (removed)
Description Get a deployment by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_CreateDeployment (removed)
Description Create a deployment for an app, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
deployment:
{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_DeleteDeployment (removed)
Description Delete a deployment by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListDeploymentLog (removed)
Description List deployment log for specific deployment for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log
{
resourceGroupName: string ,
name: string ,
id: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_ListDomainOwnershipIdentifiers (removed)
Description Lists ownership identifiers for domain associated with web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetDomainOwnershipIdentifier (removed)
Description Get domain ownership identifier for web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_CreateOrUpdateDomainOwnershipIdentifier (removed)
Description Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
domainOwnershipIdentifier:
{
properties:
{
id: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_DeleteDomainOwnershipIdentifier (removed)
Description Deletes a domain ownership identifier for a web app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_UpdateDomainOwnershipIdentifier (removed)
Description Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
domainOwnershipIdentifier:
{
properties:
{
id: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_GetMSDeployStatus (removed)
Description Get the status of the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}
WebApps_CreateMSDeployOperation (removed)
Description Invoke the MSDeploy web app extension.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
MSDeploy:
{
properties:
{
addOnPackages:
[
{
packageUri: string ,
connectionString: string ,
dbType: string ,
setParametersXmlFileUri: string ,
setParameters: object ,
skipAppData: boolean ,
appOffline: boolean ,
}
,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}

⚐ Response (409)

{}
WebApps_GetMSDeployLog (removed)
Description Get the MSDeploy Log for the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entries:
[
{
time: string ,
type: enum ,
message: string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_ListFunctions (removed)
Description List the functions for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetFunctionsAdminToken (removed)
Description Fetch a short lived token that can be exchanged for a master key.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_GetFunction (removed)
Description Get function information by its ID for web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateFunction (removed)
Description Create function for web site, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
function_envelope:
{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
WebApps_DeleteFunction (removed)
Description Delete a function for web site, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_ListFunctionSecrets (removed)
Description Get function secrets for a function in a web site, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets
{
resourceGroupName: string ,
name: string ,
functionName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
key: string ,
triggerUrl: string ,
}
,
}
WebApps_ListHostNameBindings (removed)
Description Get hostname bindings for an app or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetHostNameBinding (removed)
Description Get the named hostname binding for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
WebApps_CreateOrUpdateHostNameBinding (removed)
Description Creates a hostname binding for an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
hostName: string ,
hostNameBinding:
{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
WebApps_DeleteHostNameBinding (removed)
Description Deletes a hostname binding for an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_GetHybridConnection (removed)
Description Retrieves a specific Service Bus Hybrid Connection used by this Web App.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_CreateOrUpdateHybridConnection (removed)
Description Creates a new Hybrid Connection using a Service Bus relay.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
connectionEnvelope:
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_DeleteHybridConnection (removed)
Description Removes a Hybrid Connection from this site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateHybridConnection (removed)
Description Creates a new Hybrid Connection using a Service Bus relay.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
connectionEnvelope:
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_ListHybridConnectionKeys (removed)
Description Gets the send key name and value for a Hybrid Connection.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sendKeyName: string ,
sendKeyValue: string ,
}
,
}
WebApps_ListHybridConnections (removed)
Description Retrieves all Service Bus Hybrid Connections used by this Web App.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_ListRelayServiceConnections (removed)
Description Gets hybrid connections configured for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_GetRelayServiceConnection (removed)
Description Gets a hybrid connection configuration by its name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_CreateOrUpdateRelayServiceConnection (removed)
Description Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
connectionEnvelope:
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_DeleteRelayServiceConnection (removed)
Description Deletes a relay service connection by its name.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateRelayServiceConnection (removed)
Description Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
connectionEnvelope:
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_ListInstanceIdentifiers (removed)
Description Gets all scale-out instances of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetInstanceMsDeployStatus (removed)
Description Get the status of the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}
WebApps_CreateInstanceMSDeployOperation (removed)
Description Invoke the MSDeploy web app extension.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
instanceId: string ,
MSDeploy:
{
properties:
{
addOnPackages:
[
{
packageUri: string ,
connectionString: string ,
dbType: string ,
setParametersXmlFileUri: string ,
setParameters: object ,
skipAppData: boolean ,
appOffline: boolean ,
}
,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}

⚐ Response (409)

{}
WebApps_GetInstanceMSDeployLog (removed)
Description Get the MSDeploy Log for the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log
{
resourceGroupName: string ,
name: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entries:
[
{
time: string ,
type: enum ,
message: string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcesses (removed)
Description Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes
{
resourceGroupName: string ,
name: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcess (removed)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteInstanceProcess (removed)
Description Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_GetInstanceProcessDump (removed)
Description Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessModules (removed)
Description List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessModule (removed)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName: string ,
name: string ,
processId: string ,
baseAddress: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessThreads (removed)
Description List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads
{
resourceGroupName: string ,
name: string ,
processId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessThread (removed)
Description Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads/{threadId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
threadId: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}

⚐ Response (404)

{}
WebApps_IsCloneable (removed)
Description Shows whether an app can be cloned to another resource group or subscription.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
result: enum ,
blockingFeatures:
[
{
name: string ,
description: string ,
}
,
]
,
unsupportedFeatures:
[
{
name: string ,
description: string ,
}
,
]
,
blockingCharacteristics:
[
{
name: string ,
description: string ,
}
,
]
,
}
WebApps_ListSyncFunctionTriggers (removed)
Description This is to allow calling via powershell and ARM template.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
key: string ,
triggerUrl: string ,
}
,
}
WebApps_ListMetricDefinitions (removed)
Description Gets all metric definitions of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metricdefinitions
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name:
{
value: string ,
localizedValue: string ,
}
,
unit: string ,
primaryAggregationType: string ,
metricAvailabilities:
[
{
timeGrain: string ,
retention: string ,
}
,
]
,
resourceUri: string ,
id: string ,
properties: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListMetrics (removed)
Description Gets performance metrics of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/metrics
{
resourceGroupName: string ,
name: string ,
details: boolean ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name:
{
value: string ,
localizedValue: string ,
}
,
unit: string ,
timeGrain: string ,
startTime: string ,
endTime: string ,
resourceId: string ,
id: string ,
metricValues:
[
{
timestamp: string ,
average: number ,
minimum: number ,
maximum: number ,
total: number ,
count: number ,
properties:
[
{
key: string ,
value: string ,
}
,
]
,
}
,
]
,
properties:
[
{
key: string ,
value: string ,
}
,
]
,
}
,
]
,
nextLink: string ,
}
WebApps_MigrateStorage (removed)
Description Restores a web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate
{
subscriptionName: string ,
resourceGroupName: string ,
name: string ,
migrationOptions:
{
properties:
{
azurefilesConnectionString: string ,
azurefilesShare: string ,
switchSiteAfterMigration: boolean ,
blockWriteAccessToSite: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
operationId: string ,
}
,
}
WebApps_MigrateMySql (removed)
Description Migrates a local (in-app) MySql database to a remote MySql database.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql
{
resourceGroupName: string ,
name: string ,
migrationRequestEnvelope:
{
properties:
{
connectionString: string ,
migrationType: enum ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
status: enum ,
errors:
[
{
extendedCode: string ,
messageTemplate: string ,
parameters:
[
string ,
]
,
innerErrors:
[
string ,
]
,
code: string ,
message: string ,
}
,
]
,
createdTime: string ,
modifiedTime: string ,
expirationTime: string ,
geoMasterOperationId: string ,
}
WebApps_GetMigrateMySqlStatus (removed)
Description Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
migrationOperationStatus: enum ,
operationId: string ,
localMySqlEnabled: boolean ,
}
,
}
WebApps_ListNetworkFeatures (removed)
Description Gets all network features used by the app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}
{
resourceGroupName: string ,
name: string ,
view: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
virtualNetworkName: string ,
virtualNetworkConnection:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
hybridConnections:
[
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
]
,
hybridConnectionsV2:
[
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_StartWebSiteNetworkTrace (removed)
Description Start capturing network packets for the site.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start
{
resourceGroupName: string ,
name: string ,
durationInSeconds: integer ,
maxFrameLength: integer ,
sasUrl: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_StopWebSiteNetworkTrace (removed)
Description Stop ongoing capturing network packets for the site.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_GenerateNewSitePublishingPassword (removed)
Description Generates a new publishing password for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListPerfMonCounters (removed)
Description Gets perfmon counters for web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters
{
resourceGroupName: string ,
name: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
code: string ,
message: string ,
data:
{
name: string ,
startTime: string ,
endTime: string ,
timeGrain: string ,
values:
[
{
time: string ,
instanceName: string ,
value: number ,
coreCount: integer ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSitePhpErrorLogFlag (removed)
Description Gets web app's event logs.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
localLogErrors: string ,
masterLogErrors: string ,
localLogErrorsMaxLength: string ,
masterLogErrorsMaxLength: string ,
}
,
}
WebApps_ListPremierAddOns (removed)
Description Gets the premier add-ons of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_GetPremierAddOn (removed)
Description Gets a named add-on of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_AddPremierAddOn (removed)
Description Updates a named add-on of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
premierAddOn:
{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_DeletePremierAddOn (removed)
Description Delete a premier add-on from an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_ListProcesses (removed)
Description Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcess (removed)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteProcess (removed)
Description Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_GetProcessDump (removed)
Description Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (404)

{}
WebApps_ListProcessModules (removed)
Description List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessModule (removed)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName: string ,
name: string ,
processId: string ,
baseAddress: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListProcessThreads (removed)
Description List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads
{
resourceGroupName: string ,
name: string ,
processId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessThread (removed)
Description Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads/{threadId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
threadId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListPublicCertificates (removed)
Description Get public certificates for an app or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetPublicCertificate (removed)
Description Get the named public certificate for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
publicCertificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
WebApps_CreateOrUpdatePublicCertificate (removed)
Description Creates a hostname binding for an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
publicCertificateName: string ,
publicCertificate:
{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
WebApps_DeletePublicCertificate (removed)
Description Deletes a hostname binding for an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
publicCertificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListPublishingProfileXmlWithSecrets (removed)
Description Gets the publishing profile for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml
{
resourceGroupName: string ,
name: string ,
publishingProfileOptions:
{
format: enum ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}
WebApps_Recover (removed)
Description Recovers a web app to a previous snapshot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/recover
{
resourceGroupName: string ,
name: string ,
recoveryEntity:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}
WebApps_ResetProductionSlotConfig (removed)
Description Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_Restart (removed)
Description Restarts an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart
{
resourceGroupName: string ,
name: string ,
softRestart: boolean ,
synchronous: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_ListSiteExtensions (removed)
Description Get list of site extensions for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetSiteExtension (removed)
Description Get site extension information by its ID for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (404)

{}
WebApps_InstallSiteExtension (removed)
Description Install site extension on a web site, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (200)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (429)

{}
WebApps_DeleteSiteExtension (removed)
Description Remove a site extension from a web site, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_ListSlots (removed)
Description Gets an app's deployment slots.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSlot (removed)
Description Gets the details of a web, mobile, or API app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateOrUpdateSlot (removed)
Description Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName: string ,
name: string ,
siteEnvelope:
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
,
slot: string ,
skipDnsRegistration: boolean ,
skipCustomDomainVerification: boolean ,
forceDnsRegistration: boolean ,
ttlInSeconds: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (202)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
WebApps_DeleteSlot (removed)
Description Deletes a web, mobile, or API app, or one of the deployment slots.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName: string ,
name: string ,
slot: string ,
deleteMetrics: boolean ,
deleteEmptyServerFarm: boolean ,
skipDnsRegistration: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_UpdateSlot (removed)
Description Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}
{
resourceGroupName: string ,
name: string ,
siteEnvelope:
{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
}
,
slot: string ,
skipDnsRegistration: boolean ,
skipCustomDomainVerification: boolean ,
forceDnsRegistration: boolean ,
ttlInSeconds: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}

⚐ Response (202)

{
properties:
{
state: string ,
hostNames:
[
string ,
]
,
repositorySiteName: string ,
usageState: enum ,
enabled: boolean ,
enabledHostNames:
[
string ,
]
,
availabilityState: enum ,
hostNameSslStates:
[
{
name: string ,
sslState: enum ,
virtualIP: string ,
thumbprint: string ,
toUpdate: boolean ,
hostType: enum ,
}
,
]
,
serverFarmId: string ,
reserved: boolean ,
lastModifiedTimeUtc: string ,
siteConfig:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
trafficManagerHostNames:
[
string ,
]
,
scmSiteAlsoStopped: boolean ,
targetSwapSlot: string ,
hostingEnvironmentProfile:
{
id: string ,
name: string ,
type: string ,
}
,
clientAffinityEnabled: boolean ,
clientCertEnabled: boolean ,
hostNamesDisabled: boolean ,
outboundIpAddresses: string ,
possibleOutboundIpAddresses: string ,
containerSize: integer ,
dailyMemoryTimeQuota: integer ,
suspendedTill: string ,
maxNumberOfWorkers: integer ,
cloningInfo:
{
correlationId: string ,
overwrite: boolean ,
cloneCustomHostNames: boolean ,
cloneSourceControl: boolean ,
sourceWebAppId: string ,
hostingEnvironment: string ,
appSettingsOverrides: object ,
configureLoadBalancing: boolean ,
trafficManagerProfileId: string ,
trafficManagerProfileName: string ,
ignoreQuotas: boolean ,
}
,
snapshotInfo:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
resourceGroup: string ,
isDefaultContainer: boolean ,
defaultHostName: string ,
slotSwapStatus:
{
timestampUtc: string ,
sourceSlotName: string ,
destinationSlotName: string ,
}
,
httpsOnly: boolean ,
}
,
identity:
{
type: enum ,
tenantId: string ,
principalId: string ,
}
,
}
WebApps_AnalyzeCustomHostnameSlot (removed)
Description Analyze a custom hostname.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname
{
resourceGroupName: string ,
name: string ,
slot: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isHostnameAlreadyVerified: boolean ,
customDomainVerificationTest: enum ,
customDomainVerificationFailureInfo:
{
extendedCode: string ,
messageTemplate: string ,
parameters:
[
string ,
]
,
innerErrors:
[
string ,
]
,
code: string ,
message: string ,
}
,
hasConflictOnScaleUnit: boolean ,
hasConflictAcrossSubscription: boolean ,
conflictingAppResourceId: string ,
cNameRecords:
[
string ,
]
,
txtRecords:
[
string ,
]
,
aRecords:
[
string ,
]
,
alternateCNameRecords:
[
string ,
]
,
alternateTxtRecords:
[
string ,
]
,
}
,
}
WebApps_ApplySlotConfigurationSlot (removed)
Description Applies the configuration settings from the target slot onto the current slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_BackupSlot (removed)
Description Creates a backup of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_ListBackupsSlot (removed)
Description Gets existing backups of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_DiscoverRestoreSlot (removed)
Description Discovers an existing app backup that can be restored from a blob in Azure storage.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/discover
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
WebApps_GetBackupStatusSlot (removed)
Description Gets a backup of an app by its ID.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName: string ,
name: string ,
backupId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_DeleteBackupSlot (removed)
Description Deletes a backup of an app by its ID.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
{
resourceGroupName: string ,
name: string ,
backupId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListBackupStatusSecretsSlot (removed)
Description 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.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list
{
resourceGroupName: string ,
name: string ,
backupId: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
storageAccountUrl: string ,
blobName: string ,
name: string ,
status: enum ,
sizeInBytes: integer ,
created: string ,
log: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
scheduled: boolean ,
lastRestoreTimeStamp: string ,
finishedTimeStamp: string ,
correlationId: string ,
websiteSizeInBytes: integer ,
}
,
}
WebApps_RestoreSlot (removed)
Description Restores a specific backup to another app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore
{
resourceGroupName: string ,
name: string ,
backupId: string ,
request:
{
properties:
{
storageAccountUrl: string ,
blobName: string ,
overwrite: boolean ,
siteName: string ,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
ignoreConflictingHostNames: boolean ,
ignoreDatabases: boolean ,
appServicePlan: string ,
operationType: enum ,
adjustConnectionStrings: boolean ,
hostingEnvironment: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
operationId: string ,
}
,
}
WebApps_ListConfigurationsSlot (removed)
Description List the configurations of an app
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_UpdateApplicationSettingsSlot (removed)
Description Replaces the application settings of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings
{
resourceGroupName: string ,
name: string ,
appSettings:
{
properties: object ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListApplicationSettingsSlot (removed)
Description Gets the application settings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_UpdateAuthSettingsSlot (removed)
Description Updates the Authentication / Authorization settings associated with web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings
{
resourceGroupName: string ,
name: string ,
siteAuthSettings:
{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
WebApps_GetAuthSettingsSlot (removed)
Description Gets the Authentication/Authorization settings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
enabled: boolean ,
runtimeVersion: string ,
unauthenticatedClientAction: enum ,
tokenStoreEnabled: boolean ,
allowedExternalRedirectUrls:
[
string ,
]
,
defaultProvider: enum ,
tokenRefreshExtensionHours: number ,
clientId: string ,
clientSecret: string ,
issuer: string ,
allowedAudiences:
[
string ,
]
,
additionalLoginParams:
[
string ,
]
,
googleClientId: string ,
googleClientSecret: string ,
googleOAuthScopes:
[
string ,
]
,
facebookAppId: string ,
facebookAppSecret: string ,
facebookOAuthScopes:
[
string ,
]
,
twitterConsumerKey: string ,
twitterConsumerSecret: string ,
microsoftAccountClientId: string ,
microsoftAccountClientSecret: string ,
microsoftAccountOAuthScopes:
[
string ,
]
,
}
,
}
WebApps_UpdateBackupConfigurationSlot (removed)
Description Updates the backup configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup
{
resourceGroupName: string ,
name: string ,
request:
{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
WebApps_DeleteBackupConfigurationSlot (removed)
Description Deletes the backup configuration of an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_GetBackupConfigurationSlot (removed)
Description Gets the backup configuration of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
enabled: boolean ,
storageAccountUrl: string ,
backupSchedule:
{
frequencyInterval: integer ,
frequencyUnit: enum ,
keepAtLeastOneBackup: boolean ,
retentionPeriodInDays: integer ,
startTime: string ,
lastExecutionTime: string ,
}
,
databases:
[
{
databaseType: enum ,
name: string ,
connectionStringName: string ,
connectionString: string ,
}
,
]
,
type: enum ,
}
,
}
WebApps_UpdateConnectionStringsSlot (removed)
Description Replaces the connection strings of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings
{
resourceGroupName: string ,
name: string ,
connectionStrings:
{
properties: object ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListConnectionStringsSlot (removed)
Description Gets the connection strings of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_GetDiagnosticLogsConfigurationSlot (removed)
Description Gets the logging configuration of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
WebApps_UpdateDiagnosticLogsConfigSlot (removed)
Description Updates the logging configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
{
resourceGroupName: string ,
name: string ,
siteLogsConfig:
{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
applicationLogs:
{
fileSystem:
{
level: enum ,
}
,
azureTableStorage:
{
level: enum ,
sasUrl: string ,
}
,
azureBlobStorage:
{
level: enum ,
sasUrl: string ,
retentionInDays: integer ,
}
,
}
,
httpLogs:
{
fileSystem:
{
retentionInMb: integer ,
retentionInDays: integer ,
enabled: boolean ,
}
,
azureBlobStorage:
{
sasUrl: string ,
retentionInDays: integer ,
enabled: boolean ,
}
,
}
,
failedRequestsTracing:
{
enabled: boolean ,
}
,
detailedErrorMessages:
{
enabled: boolean ,
}
,
}
,
}
WebApps_UpdateMetadataSlot (removed)
Description Replaces the metadata of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata
{
resourceGroupName: string ,
name: string ,
metadata:
{
properties: object ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListMetadataSlot (removed)
Description Gets the metadata of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties: object ,
}
WebApps_ListPublishingCredentialsSlot (removed)
Description Gets the Git/FTP publishing credentials of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
publishingUserName: string ,
publishingPassword: string ,
publishingPasswordHash: string ,
publishingPasswordHashSalt: string ,
}
,
}
WebApps_UpdateSitePushSettingsSlot (removed)
Description Updates the Push settings associated with web app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings
{
resourceGroupName: string ,
name: string ,
pushSettings:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
WebApps_ListSitePushSettingsSlot (removed)
Description Gets the Push settings associated with web app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
WebApps_GetConfigurationSlot (removed)
Description Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_CreateOrUpdateConfigurationSlot (removed)
Description Updates the configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName: string ,
name: string ,
siteConfig:
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_UpdateConfigurationSlot (removed)
Description Updates the configuration of an app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
{
resourceGroupName: string ,
name: string ,
siteConfig:
{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_ListConfigurationSnapshotInfoSlot (removed)
Description Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
time: string ,
id: integer ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetConfigurationSnapshotSlot (removed)
Description Gets a snapshot of the configuration of an app at a previous point in time.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}
{
resourceGroupName: string ,
name: string ,
snapshotId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
numberOfWorkers: integer ,
defaultDocuments:
[
string ,
]
,
netFrameworkVersion: string ,
phpVersion: string ,
pythonVersion: string ,
nodeVersion: string ,
linuxFxVersion: string ,
requestTracingEnabled: boolean ,
requestTracingExpirationTime: string ,
remoteDebuggingEnabled: boolean ,
remoteDebuggingVersion: string ,
httpLoggingEnabled: boolean ,
logsDirectorySizeLimit: integer ,
detailedErrorLoggingEnabled: boolean ,
publishingUsername: string ,
appSettings:
[
{
name: string ,
value: string ,
}
,
]
,
connectionStrings:
[
{
name: string ,
connectionString: string ,
type: enum ,
}
,
]
,
machineKey:
{
validation: string ,
validationKey: string ,
decryption: string ,
decryptionKey: string ,
}
,
handlerMappings:
[
{
extension: string ,
scriptProcessor: string ,
arguments: string ,
}
,
]
,
documentRoot: string ,
scmType: enum ,
use32BitWorkerProcess: boolean ,
webSocketsEnabled: boolean ,
alwaysOn: boolean ,
javaVersion: string ,
javaContainer: string ,
javaContainerVersion: string ,
appCommandLine: string ,
managedPipelineMode: enum ,
virtualApplications:
[
{
virtualPath: string ,
physicalPath: string ,
preloadEnabled: boolean ,
virtualDirectories:
[
{
virtualPath: string ,
physicalPath: string ,
}
,
]
,
}
,
]
,
loadBalancing: enum ,
experiments:
{
rampUpRules:
[
{
actionHostName: string ,
reroutePercentage: number ,
changeStep: number ,
changeIntervalInMinutes: integer ,
minReroutePercentage: number ,
maxReroutePercentage: number ,
changeDecisionCallbackUrl: string ,
name: string ,
}
,
]
,
}
,
limits:
{
maxPercentageCpu: number ,
maxMemoryInMb: integer ,
maxDiskSizeInMb: integer ,
}
,
autoHealEnabled: boolean ,
autoHealRules:
{
triggers:
{
requests:
{
count: integer ,
timeInterval: string ,
}
,
privateBytesInKB: integer ,
statusCodes:
[
{
status: integer ,
subStatus: integer ,
win32Status: integer ,
count: integer ,
timeInterval: string ,
}
,
]
,
slowRequests:
{
timeTaken: string ,
count: integer ,
timeInterval: string ,
}
,
}
,
actions:
{
actionType: enum ,
customAction:
{
exe: string ,
parameters: string ,
}
,
minProcessExecutionTime: string ,
}
,
}
,
tracingOptions: string ,
vnetName: string ,
cors:
{
allowedOrigins:
[
string ,
]
,
}
,
push:
{
properties:
{
isPushEnabled: boolean ,
tagWhitelistJson: string ,
tagsRequiringAuth: string ,
dynamicTagsJson: string ,
}
,
}
,
apiDefinition:
{
url: string ,
}
,
autoSwapSlotName: string ,
localMySqlEnabled: boolean ,
ipSecurityRestrictions:
[
{
ipAddress: string ,
subnetMask: string ,
}
,
]
,
http20Enabled: boolean ,
minTlsVersion: enum ,
}
,
}
WebApps_RecoverSiteConfigurationSnapshotSlot (removed)
Description Reverts the configuration of an app to a previous snapshot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover
{
resourceGroupName: string ,
name: string ,
snapshotId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}
WebApps_GetWebSiteContainerLogsSlot (removed)
Description Gets the last lines of docker logs for the given site
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}
WebApps_GetWebSiteContainerLogsZipSlot (removed)
Description Gets the ZIP archived docker log files for the given site
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{
$schema: file ,
}
WebApps_ListContinuousWebJobsSlot (removed)
Description List continuous web jobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
status: enum ,
detailedStatus: string ,
logUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetContinuousWebJobSlot (removed)
Description Gets a continuous web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
status: enum ,
detailedStatus: string ,
logUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteContinuousWebJobSlot (removed)
Description Delete a continuous web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_StartContinuousWebJobSlot (removed)
Description Start a continuous web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_StopContinuousWebJobSlot (removed)
Description Stop a continuous web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListDeploymentsSlot (removed)
Description List deployments for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetDeploymentSlot (removed)
Description Get a deployment by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_CreateDeploymentSlot (removed)
Description Create a deployment for an app, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
slot: string ,
deployment:
{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_DeleteDeploymentSlot (removed)
Description Delete a deployment by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
{
resourceGroupName: string ,
name: string ,
id: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListDeploymentLogSlot (removed)
Description List deployment log for specific deployment for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log
{
resourceGroupName: string ,
name: string ,
id: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
status: integer ,
message: string ,
author: string ,
deployer: string ,
authorEmail: string ,
startTime: string ,
endTime: string ,
active: boolean ,
details: string ,
}
,
}
WebApps_ListDomainOwnershipIdentifiersSlot (removed)
Description Lists ownership identifiers for domain associated with web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetDomainOwnershipIdentifierSlot (removed)
Description Get domain ownership identifier for web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot (removed)
Description Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
domainOwnershipIdentifier:
{
properties:
{
id: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_DeleteDomainOwnershipIdentifierSlot (removed)
Description Deletes a domain ownership identifier for a web app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_UpdateDomainOwnershipIdentifierSlot (removed)
Description Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
{
resourceGroupName: string ,
name: string ,
domainOwnershipIdentifierName: string ,
domainOwnershipIdentifier:
{
properties:
{
id: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
}
,
}
WebApps_GetMSDeployStatusSlot (removed)
Description Get the status of the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}
WebApps_CreateMSDeployOperationSlot (removed)
Description Invoke the MSDeploy web app extension.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
slot: string ,
MSDeploy:
{
properties:
{
addOnPackages:
[
{
packageUri: string ,
connectionString: string ,
dbType: string ,
setParametersXmlFileUri: string ,
setParameters: object ,
skipAppData: boolean ,
appOffline: boolean ,
}
,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}

⚐ Response (409)

{}
WebApps_GetMSDeployLogSlot (removed)
Description Get the MSDeploy Log for the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entries:
[
{
time: string ,
type: enum ,
message: string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceFunctionsSlot (removed)
Description List the functions for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetFunctionsAdminTokenSlot (removed)
Description Fetch a short lived token that can be exchanged for a master key.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_GetInstanceFunctionSlot (removed)
Description Get function information by its ID for web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateInstanceFunctionSlot (removed)
Description Create function for web site, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
slot: string ,
function_envelope:
{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
name: string ,
functionAppId: string ,
scriptRootPathHref: string ,
scriptHref: string ,
configHref: string ,
secretsFileHref: string ,
href: string ,
config: object ,
files: object ,
testData: string ,
}
,
}
WebApps_DeleteInstanceFunctionSlot (removed)
Description Delete a function for web site, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}
{
resourceGroupName: string ,
name: string ,
functionName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_ListFunctionSecretsSlot (removed)
Description Get function secrets for a function in a web site, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets
{
resourceGroupName: string ,
name: string ,
functionName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
key: string ,
triggerUrl: string ,
}
,
}
WebApps_ListHostNameBindingsSlot (removed)
Description Get hostname bindings for an app or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetHostNameBindingSlot (removed)
Description Get the named hostname binding for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
slot: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
WebApps_CreateOrUpdateHostNameBindingSlot (removed)
Description Creates a hostname binding for an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
hostName: string ,
hostNameBinding:
{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
siteName: string ,
domainId: string ,
azureResourceName: string ,
azureResourceType: enum ,
customHostNameDnsRecordType: enum ,
hostNameType: enum ,
sslState: enum ,
thumbprint: string ,
virtualIP: string ,
}
,
}
WebApps_DeleteHostNameBindingSlot (removed)
Description Deletes a hostname binding for an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
{
resourceGroupName: string ,
name: string ,
slot: string ,
hostName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_GetHybridConnectionSlot (removed)
Description Retrieves a specific Service Bus Hybrid Connection used by this Web App.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_CreateOrUpdateHybridConnectionSlot (removed)
Description Creates a new Hybrid Connection using a Service Bus relay.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
connectionEnvelope:
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_DeleteHybridConnectionSlot (removed)
Description Removes a Hybrid Connection from this site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateHybridConnectionSlot (removed)
Description Creates a new Hybrid Connection using a Service Bus relay.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
connectionEnvelope:
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_ListHybridConnectionKeysSlot (removed)
Description Gets the send key name and value for a Hybrid Connection.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys
{
resourceGroupName: string ,
name: string ,
namespaceName: string ,
relayName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sendKeyName: string ,
sendKeyValue: string ,
}
,
}
WebApps_ListHybridConnectionsSlot (removed)
Description Retrieves all Service Bus Hybrid Connections used by this Web App.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
WebApps_ListRelayServiceConnectionsSlot (removed)
Description Gets hybrid connections configured for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_GetRelayServiceConnectionSlot (removed)
Description Gets a hybrid connection configuration by its name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_CreateOrUpdateRelayServiceConnectionSlot (removed)
Description Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
connectionEnvelope:
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_DeleteRelayServiceConnectionSlot (removed)
Description Deletes a relay service connection by its name.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateRelayServiceConnectionSlot (removed)
Description Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
{
resourceGroupName: string ,
name: string ,
entityName: string ,
connectionEnvelope:
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
WebApps_ListInstanceIdentifiersSlot (removed)
Description Gets all scale-out instances of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetInstanceMsDeployStatusSlot (removed)
Description Get the status of the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}
WebApps_CreateInstanceMSDeployOperationSlot (removed)
Description Invoke the MSDeploy web app extension.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy
{
resourceGroupName: string ,
name: string ,
slot: string ,
instanceId: string ,
MSDeploy:
{
properties:
{
addOnPackages:
[
{
packageUri: string ,
connectionString: string ,
dbType: string ,
setParametersXmlFileUri: string ,
setParameters: object ,
skipAppData: boolean ,
appOffline: boolean ,
}
,
]
,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
deployer: string ,
provisioningState: enum ,
startTime: string ,
endTime: string ,
complete: boolean ,
}
,
}

⚐ Response (409)

{}
WebApps_GetInstanceMSDeployLogSlot (removed)
Description Get the MSDeploy Log for the last MSDeploy operation.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log
{
resourceGroupName: string ,
name: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
entries:
[
{
time: string ,
type: enum ,
message: string ,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessesSlot (removed)
Description Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes
{
resourceGroupName: string ,
name: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessSlot (removed)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteInstanceProcessSlot (removed)
Description Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_GetInstanceProcessDumpSlot (removed)
Description Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessModulesSlot (removed)
Description List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessModuleSlot (removed)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName: string ,
name: string ,
processId: string ,
baseAddress: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListInstanceProcessThreadsSlot (removed)
Description List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetInstanceProcessThreadSlot (removed)
Description Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads/{threadId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
threadId: string ,
slot: string ,
instanceId: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}

⚐ Response (404)

{}
WebApps_IsCloneableSlot (removed)
Description Shows whether an app can be cloned to another resource group or subscription.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
result: enum ,
blockingFeatures:
[
{
name: string ,
description: string ,
}
,
]
,
unsupportedFeatures:
[
{
name: string ,
description: string ,
}
,
]
,
blockingCharacteristics:
[
{
name: string ,
description: string ,
}
,
]
,
}
WebApps_ListSyncFunctionTriggersSlot (removed)
Description This is to allow calling via powershell and ARM template.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
key: string ,
triggerUrl: string ,
}
,
}
WebApps_ListMetricDefinitionsSlot (removed)
Description Gets all metric definitions of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metricdefinitions
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name:
{
value: string ,
localizedValue: string ,
}
,
unit: string ,
primaryAggregationType: string ,
metricAvailabilities:
[
{
timeGrain: string ,
retention: string ,
}
,
]
,
resourceUri: string ,
id: string ,
properties: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListMetricsSlot (removed)
Description Gets performance metrics of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/metrics
{
resourceGroupName: string ,
name: string ,
slot: string ,
details: boolean ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name:
{
value: string ,
localizedValue: string ,
}
,
unit: string ,
timeGrain: string ,
startTime: string ,
endTime: string ,
resourceId: string ,
id: string ,
metricValues:
[
{
timestamp: string ,
average: number ,
minimum: number ,
maximum: number ,
total: number ,
count: number ,
properties:
[
{
key: string ,
value: string ,
}
,
]
,
}
,
]
,
properties:
[
{
key: string ,
value: string ,
}
,
]
,
}
,
]
,
nextLink: string ,
}
WebApps_GetMigrateMySqlStatusSlot (removed)
Description Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
migrationOperationStatus: enum ,
operationId: string ,
localMySqlEnabled: boolean ,
}
,
}
WebApps_ListNetworkFeaturesSlot (removed)
Description Gets all network features used by the app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}
{
resourceGroupName: string ,
name: string ,
view: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
virtualNetworkName: string ,
virtualNetworkConnection:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
hybridConnections:
[
{
properties:
{
entityName: string ,
entityConnectionString: string ,
resourceType: string ,
resourceConnectionString: string ,
hostname: string ,
port: integer ,
biztalkUri: string ,
}
,
}
,
]
,
hybridConnectionsV2:
[
{
properties:
{
serviceBusNamespace: string ,
relayName: string ,
relayArmUri: string ,
hostname: string ,
port: integer ,
sendKeyName: string ,
sendKeyValue: string ,
serviceBusSuffix: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_StartWebSiteNetworkTraceSlot (removed)
Description Start capturing network packets for the site.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start
{
resourceGroupName: string ,
name: string ,
durationInSeconds: integer ,
slot: string ,
maxFrameLength: integer ,
sasUrl: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_StopWebSiteNetworkTraceSlot (removed)
Description Stop ongoing capturing network packets for the site.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: string ,
}
WebApps_GenerateNewSitePublishingPasswordSlot (removed)
Description Generates a new publishing password for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListPerfMonCountersSlot (removed)
Description Gets perfmon counters for web app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters
{
resourceGroupName: string ,
name: string ,
slot: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
code: string ,
message: string ,
data:
{
name: string ,
startTime: string ,
endTime: string ,
timeGrain: string ,
values:
[
{
time: string ,
instanceName: string ,
value: number ,
coreCount: integer ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSitePhpErrorLogFlagSlot (removed)
Description Gets web app's event logs.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
localLogErrors: string ,
masterLogErrors: string ,
localLogErrorsMaxLength: string ,
masterLogErrorsMaxLength: string ,
}
,
}
WebApps_ListPremierAddOnsSlot (removed)
Description Gets the premier add-ons of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_GetPremierAddOnSlot (removed)
Description Gets a named add-on of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_AddPremierAddOnSlot (removed)
Description Updates a named add-on of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
premierAddOn:
{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
sku: string ,
product: string ,
vendor: string ,
name: string ,
location: string ,
tags: object ,
marketplacePublisher: string ,
marketplaceOffer: string ,
}
,
}
WebApps_DeletePremierAddOnSlot (removed)
Description Delete a premier add-on from an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
{
resourceGroupName: string ,
name: string ,
premierAddOnName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_ListProcessesSlot (removed)
Description Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessSlot (removed)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
name: string ,
href: string ,
miniDump: string ,
isProfileRunning: boolean ,
isIisProfileRunning: boolean ,
iisProfileTimeoutInSeconds: number ,
parent: string ,
children:
[
string ,
]
,
threads:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
openFileHandles:
[
string ,
]
,
modules:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
fileName: string ,
commandLine: string ,
userName: string ,
handleCount: integer ,
moduleCount: integer ,
threadCount: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
privilegedProcessorTime: string ,
workingSet64: integer ,
peakWorkingSet64: integer ,
privateMemorySize64: integer ,
virtualMemorySize64: integer ,
peakVirtualMemorySize64: integer ,
pagedSystemMemorySize64: integer ,
nonpagedSystemMemorySize64: integer ,
pagedMemorySize64: integer ,
peakPagedMemorySize64: integer ,
timeStamp: string ,
environmentVariables: object ,
isScmSite: boolean ,
isWebJob: boolean ,
description: string ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteProcessSlot (removed)
Description Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_GetProcessDumpSlot (removed)
Description Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ Response (404)

{}
WebApps_ListProcessModulesSlot (removed)
Description List module information for a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessModuleSlot (removed)
Description Get process information by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}
{
resourceGroupName: string ,
name: string ,
processId: string ,
baseAddress: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
baseAddress: string ,
fileName: string ,
href: string ,
filePath: string ,
moduleMemorySize: integer ,
fileVersion: string ,
fileDescription: string ,
product: string ,
productVersion: string ,
isDebug: boolean ,
language: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListProcessThreadsSlot (removed)
Description List the threads in a process by its ID for a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads
{
resourceGroupName: string ,
name: string ,
processId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetProcessThreadSlot (removed)
Description Get thread information by Thread ID for a specific process, in a specific scaled-out instance in a web site.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads/{threadId}
{
resourceGroupName: string ,
name: string ,
processId: string ,
threadId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: integer ,
href: string ,
process: string ,
startAddress: string ,
currentPriority: integer ,
priorityLevel: string ,
basePriority: integer ,
startTime: string ,
totalProcessorTime: string ,
userProcessorTime: string ,
priviledgedProcessorTime: string ,
state: string ,
waitReason: string ,
}
,
}

⚐ Response (404)

{}
WebApps_ListPublicCertificatesSlot (removed)
Description Get public certificates for an app or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetPublicCertificateSlot (removed)
Description Get the named public certificate for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
slot: string ,
publicCertificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
WebApps_CreateOrUpdatePublicCertificateSlot (removed)
Description Creates a hostname binding for an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
publicCertificateName: string ,
publicCertificate:
{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
blob: string ,
publicCertificateLocation: enum ,
thumbprint: string ,
}
,
}
WebApps_DeletePublicCertificateSlot (removed)
Description Deletes a hostname binding for an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
{
resourceGroupName: string ,
name: string ,
slot: string ,
publicCertificateName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListPublishingProfileXmlWithSecretsSlot (removed)
Description Gets the publishing profile for an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml
{
resourceGroupName: string ,
name: string ,
publishingProfileOptions:
{
format: enum ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
$schema: file ,
}
WebApps_RecoverSlot (removed)
Description Recovers a web app to a previous snapshot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/recover
{
resourceGroupName: string ,
name: string ,
recoveryEntity:
{
properties:
{
snapshotTime: string ,
recoveryTarget:
{
location: string ,
id: string ,
}
,
overwrite: boolean ,
recoverConfiguration: boolean ,
ignoreConflictingHostNames: boolean ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{}
WebApps_ResetSlotConfigurationSlot (removed)
Description Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_RestartSlot (removed)
Description Restarts an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart
{
resourceGroupName: string ,
name: string ,
slot: string ,
softRestart: boolean ,
synchronous: boolean ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_ListSiteExtensionsSlot (removed)
Description Get list of site extensions for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetSiteExtensionSlot (removed)
Description Get site extension information by its ID for a web site, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (404)

{}
WebApps_InstallSiteExtensionSlot (removed)
Description Install site extension on a web site, or a deployment slot.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (201)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (200)

{
properties:
{
id: string ,
title: string ,
type: enum ,
summary: string ,
description: string ,
version: string ,
extensionUrl: string ,
projectUrl: string ,
iconUrl: string ,
licenseUrl: string ,
feedUrl: string ,
authors:
[
string ,
]
,
installationArgs: string ,
publishedDateTime: string ,
downloadCount: integer ,
localIsLatestVersion: boolean ,
localPath: string ,
installedDateTime: string ,
provisioningState: string ,
comment: string ,
}
,
}

⚐ Response (429)

{}
WebApps_DeleteSiteExtensionSlot (removed)
Description Remove a site extension from a web site, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
{
resourceGroupName: string ,
name: string ,
siteExtensionId: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}
WebApps_ListSlotDifferencesSlot (removed)
Description Get the difference in configuration settings between two web app slots.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
type: string ,
settingType: string ,
diffRule: string ,
settingName: string ,
valueInCurrentSlot: string ,
valueInTargetSlot: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_SwapSlotSlot (removed)
Description Swaps two deployment slots of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
WebApps_ListSnapshotsSlot (removed)
Description Returns all Snapshots to the user.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
time: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSourceControlSlot (removed)
Description Gets the source control configuration of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_CreateOrUpdateSourceControlSlot (removed)
Description Updates the source control configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
siteSourceControl:
{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_DeleteSourceControlSlot (removed)
Description Deletes the source control configuration of an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (404)

{}
WebApps_UpdateSourceControlSlot (removed)
Description Updates the source control configuration of an app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
siteSourceControl:
{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_StartSlot (removed)
Description Starts an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_StopSlot (removed)
Description Stops an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_SyncRepositorySlot (removed)
Description Sync web app repository.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_SyncFunctionTriggersSlot (removed)
Description Syncs function trigger metadata to the scale controller
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}
WebApps_ListTriggeredWebJobsSlot (removed)
Description List triggered web jobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
latestRun:
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
historyUrl: string ,
schedulerLogsUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetTriggeredWebJobSlot (removed)
Description Gets a triggered web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
latestRun:
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
historyUrl: string ,
schedulerLogsUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteTriggeredWebJobSlot (removed)
Description Delete a triggered web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListTriggeredWebJobHistorySlot (removed)
Description List a triggered web job's history for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
triggeredJobRuns:
[
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetTriggeredWebJobHistorySlot (removed)
Description Gets a triggered web job's history by its ID for an app, , or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
id: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
triggeredJobRuns:
[
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_RunTriggeredWebJobSlot (removed)
Description Run a triggered web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListUsagesSlot (removed)
Description Gets the quota usage information of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages
{
resourceGroupName: string ,
name: string ,
slot: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
unit: string ,
nextResetTime: string ,
currentValue: integer ,
limit: integer ,
name:
{
value: string ,
localizedValue: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListVnetConnectionsSlot (removed)
Description Gets the virtual networks the app (or deployment slot) is connected to.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_GetVnetConnectionSlot (removed)
Description Gets a virtual network the app (or deployment slot) is connected to by name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_CreateOrUpdateVnetConnectionSlot (removed)
Description Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
connectionEnvelope:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_DeleteVnetConnectionSlot (removed)
Description Deletes a connection from an app (or deployment slot to a named virtual network.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateVnetConnectionSlot (removed)
Description Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
connectionEnvelope:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_GetVnetConnectionGatewaySlot (removed)
Description Gets an app's Virtual Network gateway.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateOrUpdateVnetConnectionGatewaySlot (removed)
Description Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
connectionEnvelope:
{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
WebApps_UpdateVnetConnectionGatewaySlot (removed)
Description Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
connectionEnvelope:
{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
WebApps_ListWebJobsSlot (removed)
Description List webjobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs
{
resourceGroupName: string ,
name: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetWebJobSlot (removed)
Description Get webjob information for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
slot: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
WebApps_ListSlotDifferencesFromProduction (removed)
Description Get the difference in configuration settings between two web app slots.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
type: string ,
settingType: string ,
diffRule: string ,
settingName: string ,
valueInCurrentSlot: string ,
valueInTargetSlot: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_SwapSlotWithProduction (removed)
Description Swaps two deployment slots of an app.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap
{
resourceGroupName: string ,
name: string ,
slotSwapEntity:
{
targetSlot: string ,
preserveVnet: boolean ,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}
WebApps_ListSnapshots (removed)
Description Returns all Snapshots to the user.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
time: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetSourceControl (removed)
Description Gets the source control configuration of an app.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_CreateOrUpdateSourceControl (removed)
Description Updates the source control configuration of an app.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
siteSourceControl:
{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (202)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_DeleteSourceControl (removed)
Description Deletes the source control configuration of an app.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (404)

{}
WebApps_UpdateSourceControl (removed)
Description Updates the source control configuration of an app.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
{
resourceGroupName: string ,
name: string ,
siteSourceControl:
{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
repoUrl: string ,
branch: string ,
isManualIntegration: boolean ,
deploymentRollbackEnabled: boolean ,
isMercurial: boolean ,
}
,
}
WebApps_Start (removed)
Description Starts an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_Stop (removed)
Description Stops an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_SyncRepository (removed)
Description Sync web app repository.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}
WebApps_SyncFunctionTriggers (removed)
Description Syncs function trigger metadata to the scale controller
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (204)

{}
WebApps_ListTriggeredWebJobs (removed)
Description List triggered web jobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
latestRun:
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
historyUrl: string ,
schedulerLogsUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetTriggeredWebJob (removed)
Description Gets a triggered web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
latestRun:
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
historyUrl: string ,
schedulerLogsUrl: string ,
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}

⚐ Response (404)

{}
WebApps_DeleteTriggeredWebJob (removed)
Description Delete a triggered web job by its ID for an app, or a deployment slot.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
WebApps_ListTriggeredWebJobHistory (removed)
Description List a triggered web job's history for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
triggeredJobRuns:
[
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (404)

{}
WebApps_GetTriggeredWebJobHistory (removed)
Description Gets a triggered web job's history by its ID for an app, , or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
id: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
triggeredJobRuns:
[
{
properties:
{
id: string ,
name: string ,
status: enum ,
startTime: string ,
endTime: string ,
duration: string ,
outputUrl: string ,
errorUrl: string ,
url: string ,
jobName: string ,
trigger: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}
WebApps_RunTriggeredWebJob (removed)
Description Run a triggered web job for an app, or a deployment slot.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_ListUsages (removed)
Description Gets the quota usage information of an app (or deployment slot, if specified).
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages
{
resourceGroupName: string ,
name: string ,
$filter: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
unit: string ,
nextResetTime: string ,
currentValue: integer ,
limit: integer ,
name:
{
value: string ,
localizedValue: string ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_ListVnetConnections (removed)
Description Gets the virtual networks the app (or deployment slot) is connected to.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_GetVnetConnection (removed)
Description Gets a virtual network the app (or deployment slot) is connected to by name.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_CreateOrUpdateVnetConnection (removed)
Description Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
connectionEnvelope:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_DeleteVnetConnection (removed)
Description Deletes a connection from an app (or deployment slot to a named virtual network.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (404)

{}
WebApps_UpdateVnetConnection (removed)
Description Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
connectionEnvelope:
{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetResourceId: string ,
certThumbprint: string ,
certBlob: string ,
routes:
[
{
properties:
{
name: string ,
startAddress: string ,
endAddress: string ,
routeType: enum ,
}
,
}
,
]
,
resyncRequired: boolean ,
dnsServers: string ,
}
,
}
WebApps_GetVnetConnectionGateway (removed)
Description Gets an app's Virtual Network gateway.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}

⚐ Response (404)

{}
WebApps_CreateOrUpdateVnetConnectionGateway (removed)
Description Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
connectionEnvelope:
{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
WebApps_UpdateVnetConnectionGateway (removed)
Description Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
{
resourceGroupName: string ,
name: string ,
vnetName: string ,
gatewayName: string ,
connectionEnvelope:
{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
vnetName: string ,
vpnPackageUri: string ,
}
,
}
WebApps_ListWebJobs (removed)
Description List webjobs for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs
{
resourceGroupName: string ,
name: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}
,
]
,
nextLink: string ,
}
WebApps_GetWebJob (removed)
Description Get webjob information for an app, or a deployment slot.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}
{
resourceGroupName: string ,
name: string ,
webJobName: string ,
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
runCommand: string ,
url: string ,
extraInfoUrl: string ,
jobType: enum ,
error: string ,
usingSdk: boolean ,
settings: object ,
}
,
}