swagger: '2.0'
info:
title: API Client AppServiceEnvironments WebApps API
version: '2025-05-01'
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
tags:
- name: WebApps
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites:
get:
operationId: WebApps_List
tags:
- WebApps
summary: Get all apps for a subscription.
description: Description for Get all apps for a subscription.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebAppCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Web apps for subscription:
$ref: ./examples/ListWebApps.json
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites:
get:
operationId: WebApps_ListByResourceGroup
tags:
- WebApps
summary: Gets all web, mobile, and API apps in the specified resource group.
description: Description for Gets all web, mobile, and API apps in the specified resource group.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: includeSlots
in: query
description: Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all apps.
required: false
type: boolean
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebAppCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Web Apps by Resource group:
$ref: ./examples/ListWebAppsByResourceGroup.json
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}:
get:
operationId: WebApps_Get
tags:
- WebApps
summary: Gets the details of a web, mobile, or API app.
description: Description for Gets the details of a web, mobile, or API app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Site'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get Web App:
$ref: ./examples/GetWebApp.json
put:
operationId: WebApps_CreateOrUpdate
tags:
- WebApps
summary: Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
description: Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: siteEnvelope
in: body
description: A JSON representation of the app properties. See example.
required: true
schema:
$ref: '#/definitions/Site'
responses:
'200':
description: Resource 'Site' update operation succeeded
schema:
$ref: '#/definitions/Site'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/Site'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Clone web app:
$ref: ./examples/CloneWebApp.json
Create or Update Flex Consumption function app:
$ref: ./examples/CreateOrUpdateFunctionAppFlexConsumption.json
Create or Update Flex Consumption function app with details:
$ref: ./examples/CreateOrUpdateFunctionAppFlexConsumptionWithDetails.json
Create or Update web app:
$ref: ./examples/CreateOrUpdateWebApp.json
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/Site'
x-ms-long-running-operation: true
patch:
operationId: WebApps_Update
tags:
- WebApps
summary: Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
description: Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: siteEnvelope
in: body
description: A JSON representation of the app properties. See example.
required: true
schema:
$ref: '#/definitions/SitePatchResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Site'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/Site'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update web app:
$ref: ./examples/UpdateWebApp.json
delete:
operationId: WebApps_Delete
tags:
- WebApps
summary: Deletes a web, mobile, or API app, or one of the deployment slots.
description: Description for Deletes a web, mobile, or API app, or one of the deployment slots.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: deleteMetrics
in: query
description: If true, web app metrics are also deleted.
required: false
type: boolean
- name: deleteEmptyServerFarm
in: query
description: Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.
required: false
type: boolean
responses:
'200':
description: The request has succeeded.
'204':
description: There is no content to send for this request, but the headers may be useful.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Delete Web app:
$ref: ./examples/DeleteWebApp.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname
: get:
operationId: WebApps_AnalyzeCustomHostname
tags:
- WebApps
summary: Analyze a custom hostname.
description: Description for Analyze a custom hostname.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: hostName
in: query
description: Custom hostname.
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CustomHostnameAnalysisResult'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Analyze custom hostname for webapp.:
$ref: ./examples/AnalyzeCustomHostName.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig:
post:
operationId: WebApps_ApplySlotConfigToProduction
tags:
- WebApps
summary: Applies the configuration settings from the target slot onto the current slot.
description: Description for Applies the configuration settings from the target slot onto the current slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slotSwapEntity
in: body
description: JSON object that contains the target slot name. See example.
required: true
schema:
$ref: '#/definitions/CsmSlotEntity'
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Apply web app slot config:
$ref: ./examples/ApplySlotConfig.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup:
post:
operationId: WebApps_Backup
tags:
- WebApps
summary: Creates a backup of an app.
description: Description for Creates a backup of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: request
in: body
description: Backup configuration. You can use the JSON response from the POST action as input here.
required: true
schema:
$ref: '#/definitions/BackupRequest'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Backup web app:
$ref: ./examples/BackupWebApp.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups:
get:
operationId: WebApps_ListBackups
tags:
- WebApps
summary: Gets existing backups of an app.
description: Description for Gets existing backups of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItemCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List web app backups:
$ref: ./examples/ListWebAppBackups.json
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}:
get:
operationId: WebApps_GetBackupStatus
tags:
- WebApps
summary: Gets a backup of an app by its ID.
description: Description for Gets a backup of an app by its ID.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: backupId
in: path
description: ID of the backup.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get web app backup:
$ref: ./examples/GetWebAppBackup.json
delete:
operationId: WebApps_DeleteBackup
tags:
- WebApps
summary: Deletes a backup of an app by its ID.
description: Description for Deletes a backup of an app by its ID.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: backupId
in: path
description: ID of the backup.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Delete web app backup:
$ref: ./examples/DeleteWebAppBackup.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list
: post:
operationId: WebApps_ListBackupStatusSecrets
tags:
- WebApps
summary: Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
description: Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: backupId
in: path
description: ID of the backup.
required: true
type: string
- name: request
in: body
description: Information on backup request.
required: true
schema:
$ref: '#/definitions/BackupRequest'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get web app backup with secrets:
$ref: ./examples/GetWebAppBackupWithSecrets.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore
: post:
operationId: WebApps_Restore
tags:
- WebApps
summary: Restores a specific backup to another app (or deployment slot, if specified).
description: Description for Restores a specific backup to another app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: backupId
in: path
description: ID of the backup.
required: true
type: string
- name: request
in: body
description: Information on restore request .
required: true
schema:
$ref: '#/definitions/RestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Restore web app from backup:
$ref: ./examples/RestoreWebAppBackup.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies
: get:
operationId: WebApps_ListBasicPublishingCredentialsPolicies
tags:
- WebApps
summary: Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
description: Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PublishingCredentialsPoliciesCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Publishing Credentials Policies:
$ref: ./examples/ListPublishingCredentialsPolicies.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp
: get:
operationId: WebApps_GetFtpAllowed
tags:
- WebApps
summary: Returns whether FTP is allowed on the site or not.
description: Description for Returns whether FTP is allowed on the site or not.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get FTP Allowed:
$ref: ./examples/GetPublishingCredentialsPolicy_GetFtpAllowed.json
put:
operationId: WebApps_UpdateFtpAllowed
tags:
- WebApps
summary: Updates whether FTP is allowed on the site or not.
description: Description for Updates whether FTP is allowed on the site or not.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: csmPublishingAccessPoliciesEntity
in: body
description: ''
required: true
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
responses:
'200':
description: Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update FTP Allowed:
$ref: ./examples/UpdatePublishingCredentialsPolicy_UpdateFtpAllowed.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm
: get:
operationId: WebApps_GetScmAllowed
tags:
- WebApps
summary: Returns whether Scm basic auth is allowed on the site or not.
description: Description for Returns whether Scm basic auth is allowed on the site or not.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get SCM Allowed:
$ref: ./examples/GetPublishingCredentialsPolicy.json
put:
operationId: WebApps_UpdateScmAllowed
tags:
- WebApps
summary: Updates whether user publishing credentials are allowed on the site or not.
description: Description for Updates whether user publishing credentials are allowed on the site or not.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: csmPublishingAccessPoliciesEntity
in: body
description: ''
required: true
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
responses:
'200':
description: Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update SCM Allowed:
$ref: ./examples/UpdatePublishingCredentialsPolicy.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config:
get:
operationId: WebApps_ListConfigurations
tags:
- WebApps
summary: List the configurations of an app
description: Description for List the configurations of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigResourceCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List web app configurations:
$ref: ./examples/ListWebAppConfigurations.json
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings:
put:
operationId: WebApps_UpdateApplicationSettings
tags:
- WebApps
summary: Replaces the application settings of an app.
description: Description for Replaces the application settings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: appSettings
in: body
description: Application settings of the app.
required: true
schema:
$ref: '#/definitions/StringDictionary'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update App Settings:
$ref: ./examples/UpdateAppSettings.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list
: post:
operationId: WebApps_ListApplicationSettings
tags:
- WebApps
summary: Gets the application settings of an app.
description: Description for Gets the application settings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List App Settings:
$ref: ./examples/ListAppSettings.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings
: put:
operationId: WebApps_UpdateAuthSettings
tags:
- WebApps
summary: Updates the Authentication / Authorization settings associated with web app.
description: Description for Updates the Authentication / Authorization settings associated with web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: siteAuthSettings
in: body
description: Auth settings associated with web app.
required: true
schema:
$ref: '#/definitions/SiteAuthSettings'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteAuthSettings'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update Auth Settings:
$ref: ./examples/UpdateAuthSettings.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list
: post:
operationId: WebApps_GetAuthSettings
tags:
- WebApps
summary: Gets the Authentication/Authorization settings of an app.
description: Description for Gets the Authentication/Authorization settings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteAuthSettings'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Auth Settings:
$ref: ./examples/ListAuthSettings.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2
: get:
operationId: WebApps_GetAuthSettingsV2WithoutSecrets
tags:
- WebApps
summary: Gets site's Authentication / Authorization settings for apps via the V2 format
description: Description for Gets site's Authentication / Authorization settings for apps via the V2 format
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteAuthSettingsV2'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Auth Settings without Secrets:
$ref: ./examples/GetAuthSettingsV2WithoutSecrets.json
put:
operationId: WebApps_UpdateAuthSettingsV2
tags:
- WebApps
summary: Updates site's Authentication / Authorization settings for apps via the V2 format
description: Description for Updates site's Authentication / Authorization settings for apps via the V2 format
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: siteAuthSettingsV2
in: body
description: Auth settings associated with web app.
required: true
schema:
$ref: '#/definitions/SiteAuthSettingsV2'
responses:
'200':
description: Resource 'SiteAuthSettingsV2' update operation succeeded
schema:
$ref: '#/definitions/SiteAuthSettingsV2'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update Auth Settings V2:
$ref: ./examples/UpdateAuthSettingsV2.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list
: get:
operationId: WebApps_GetAuthSettingsV2
tags:
- WebApps
summary: Gets site's Authentication / Authorization settings for apps via the V2 format
description: Description for Gets site's Authentication / Authorization settings for apps via the V2 format
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteAuthSettingsV2'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Auth Settings V2:
$ref: ./examples/ListAuthSettingsV2.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts
: put:
operationId: WebApps_UpdateAzureStorageAccounts
tags:
- WebApps
summary: Updates the Azure storage account configurations of an app.
description: Description for Updates the Azure storage account configurations of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: azureStorageAccounts
in: body
description: Azure storage accounts of the app.
required: true
schema:
$ref: '#/definitions/AzureStoragePropertyDictionaryResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/AzureStoragePropertyDictionaryResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update Azure Storage Accounts:
$ref: ./examples/UpdateAzureStorageAccounts.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list
: post:
operationId: WebApps_ListAzureStorageAccounts
tags:
- WebApps
summary: Gets the Azure storage account configurations of an app.
description: Description for Gets the Azure storage account configurations of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/AzureStoragePropertyDictionaryResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup:
put:
operationId: WebApps_UpdateBackupConfiguration
tags:
- WebApps
summary: Updates the backup configuration of an app.
description: Description for Updates the backup configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: request
in: body
description: Edited backup configuration.
required: true
schema:
$ref: '#/definitions/BackupRequest'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupRequest'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteBackupConfiguration
tags:
- WebApps
summary: Deletes the backup configuration of an app.
description: Description for Deletes the backup configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list:
post:
operationId: WebApps_GetBackupConfiguration
tags:
- WebApps
summary: Gets the backup configuration of an app.
description: Description for Gets the backup configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupRequest'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings
: get:
operationId: WebApps_GetAppSettingsKeyVaultReferences
tags:
- WebApps
summary: Gets the config reference app settings and status of an app
description: Description for Gets the config reference app settings and status of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ApiKVReferenceCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get Azure Key Vault references for app settings:
$ref: ./examples/GetKeyVaultReferencesForAppSettings.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey}
: get:
operationId: WebApps_GetAppSettingKeyVaultReference
tags:
- WebApps
summary: Gets the config reference and status of an app
description: Description for Gets the config reference and status of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: appSettingKey
in: path
description: App Setting key name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ApiKVReference'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get Azure Key Vault app setting reference:
$ref: ./examples/GetKeyVaultReferencesForAppSetting.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings
: get:
operationId: WebApps_GetSiteConnectionStringKeyVaultReferences
tags:
- WebApps
summary: Gets the config reference app settings and status of an app
description: Description for Gets the config reference app settings and status of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ApiKVReferenceCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings/{connectionStringKey}
: get:
operationId: WebApps_GetSiteConnectionStringKeyVaultReference
tags:
- WebApps
summary: Gets the config reference and status of an app
description: Description for Gets the config reference and status of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: connectionStringKey
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ApiKVReference'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings
: put:
operationId: WebApps_UpdateConnectionStrings
tags:
- WebApps
summary: Replaces the connection strings of an app.
description: Description for Replaces the connection strings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: connectionStrings
in: body
description: Connection strings of the app or deployment slot. See example.
required: true
schema:
$ref: '#/definitions/ConnectionStringDictionary'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ConnectionStringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list
: post:
operationId: WebApps_ListConnectionStrings
tags:
- WebApps
summary: Gets the connection strings of an app.
description: Description for Gets the connection strings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ConnectionStringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs:
get:
operationId: WebApps_GetDiagnosticLogsConfiguration
tags:
- WebApps
summary: Gets the logging configuration of an app.
description: Description for Gets the logging configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteLogsConfig'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_UpdateDiagnosticLogsConfig
tags:
- WebApps
summary: Updates the logging configuration of an app.
description: Description for Updates the logging configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: siteLogsConfig
in: body
description: A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties"property
required: true
schema:
$ref: '#/definitions/SiteLogsConfig'
responses:
'200':
description: Resource 'SiteLogsConfig' update operation succeeded
schema:
$ref: '#/definitions/SiteLogsConfig'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata:
put:
operationId: WebApps_UpdateMetadata
tags:
- WebApps
summary: Replaces the metadata of an app.
description: Description for Replaces the metadata of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: metadata
in: body
description: Edited metadata of the app or deployment slot. See example.
required: true
schema:
$ref: '#/definitions/StringDictionary'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list
: post:
operationId: WebApps_ListMetadata
tags:
- WebApps
summary: Gets the metadata of an app.
description: Description for Gets the metadata of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list
: post:
operationId: WebApps_ListPublishingCredentials
tags:
- WebApps
summary: Gets the Git/FTP publishing credentials of an app.
description: Description for Gets the Git/FTP publishing credentials of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/User'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/User'
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings
: put:
operationId: WebApps_UpdateSitePushSettings
tags:
- WebApps
summary: Updates the Push settings associated with web app.
description: Description for Updates the Push settings associated with web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: pushSettings
in: body
description: Push settings associated with web app.
required: true
schema:
$ref: '#/definitions/PushSettings'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PushSettings'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list
: post:
operationId: WebApps_ListSitePushSettings
tags:
- WebApps
summary: Gets the Push settings associated with web app.
description: Description for Gets the Push settings associated with web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PushSettings'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames
: get:
operationId: WebApps_ListSlotConfigurationNames
tags:
- WebApps
summary: Gets the names of app settings and connection strings that stick to the slot (not swapped).
description: Description for Gets the names of app settings and connection strings that stick to the slot (not swapped).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SlotConfigNamesResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_UpdateSlotConfigurationNames
tags:
- WebApps
summary: Updates the names of application settings and connection string that remain with the slot during swap operation.
description: Description for Updates the names of application settings and connection string that remain with the slot during swap operation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slotConfigNames
in: body
description: Names of application settings and connection strings. See example.
required: true
schema:
$ref: '#/definitions/SlotConfigNamesResource'
responses:
'200':
description: Resource 'SlotConfigNamesResource' update operation succeeded
schema:
$ref: '#/definitions/SlotConfigNamesResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web:
get:
operationId: WebApps_GetConfiguration
tags:
- WebApps
summary: Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
description: Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get Site Config:
$ref: ./examples/GetSiteConfig.json
put:
operationId: WebApps_CreateOrUpdateConfiguration
tags:
- WebApps
summary: Updates the configuration of an app.
description: Description for Updates the configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: siteConfig
in: body
description: JSON representation of a SiteConfig object. See example.
required: true
schema:
$ref: '#/definitions/SiteConfigResource'
responses:
'200':
description: Resource 'SiteConfigResource' update operation succeeded
schema:
$ref: '#/definitions/SiteConfigResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update Site Config:
$ref: ./examples/UpdateSiteConfig.json
patch:
operationId: WebApps_UpdateConfiguration
tags:
- WebApps
summary: Updates the configuration of an app.
description: Description for Updates the configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: siteConfig
in: body
description: JSON representation of a SiteConfig object. See example.
required: true
schema:
$ref: '#/definitions/SiteConfigResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots
: get:
operationId: WebApps_ListConfigurationSnapshotInfo
tags:
- WebApps
summary: Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
description: Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigurationSnapshotInfoCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}
: get:
operationId: WebApps_GetConfigurationSnapshot
tags:
- WebApps
summary: Gets a snapshot of the configuration of an app at a previous point in time.
description: Description for Gets a snapshot of the configuration of an app at a previous point in time.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: snapshotId
in: path
description: The ID of the snapshot to read.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover
: post:
operationId: WebApps_RecoverSiteConfigurationSnapshot
tags:
- WebApps
summary: Reverts the configuration of an app to a previous snapshot.
description: Description for Reverts the configuration of an app to a previous snapshot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: snapshotId
in: path
description: The ID of the snapshot to read.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs:
post:
operationId: WebApps_GetWebSiteContainerLogs
tags:
- WebApps
summary: Gets the last lines of docker logs for the given site
description: Description for Gets the last lines of docker logs for the given site
produces:
- application/octet-stream
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download
: post:
operationId: WebApps_GetContainerLogsZip
tags:
- WebApps
summary: Gets the ZIP archived docker log files for the given site
description: Description for Gets the ZIP archived docker log files for the given site
produces:
- application/zip
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs:
get:
operationId: WebApps_ListContinuousWebJobs
tags:
- WebApps
summary: List continuous web jobs for an app, or a deployment slot.
description: Description for List continuous web jobs for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ContinuousWebJobCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}
: get:
operationId: WebApps_GetContinuousWebJob
tags:
- WebApps
summary: Gets a continuous web job by its ID for an app, or a deployment slot.
description: Description for Gets a continuous web job by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ContinuousWebJob'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteContinuousWebJob
tags:
- WebApps
summary: Delete a continuous web job by its ID for an app, or a deployment slot.
description: Description for Delete a continuous web job by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start
: post:
operationId: WebApps_StartContinuousWebJob
tags:
- WebApps
summary: Start a continuous web job for an app, or a deployment slot.
description: Description for Start a continuous web job for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop
: post:
operationId: WebApps_StopContinuousWebJob
tags:
- WebApps
summary: Stop a continuous web job for an app, or a deployment slot.
description: Description for Stop a continuous web job for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployWorkflowArtifacts
: post:
operationId: WebApps_DeployWorkflowArtifacts
tags:
- WebApps
summary: Creates the artifacts for web site, or a deployment slot.
description: Description for Creates the artifacts for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: workflowArtifacts
in: body
description: Application settings and files of the workflow.
required: false
schema:
$ref: '#/definitions/WorkflowArtifacts'
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Delete workflow artifacts:
$ref: ./examples/DeleteDeployWorkflowArtifacts.json
Deploys workflow artifacts:
$ref: ./examples/PostDeployWorkflowArtifacts.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus:
get:
operationId: WebApps_ListProductionSiteDeploymentStatuses
tags:
- WebApps
summary: List deployment statuses for an app (or deployment slot, if specified).
description: List deployment statuses for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmDeploymentStatusCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Deployment Status:
$ref: ./examples/ListSiteDeploymentStatus.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}
: get:
operationId: WebApps_GetProductionSiteDeploymentStatus
tags:
- WebApps
summary: Gets the deployment status for an app (or deployment slot, if specified).
description: Gets the deployment status for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: deploymentStatusId
in: path
description: GUID of the deployment operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmDeploymentStatus'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/CsmDeploymentStatus'
headers:
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get Deployment Status:
$ref: ./examples/GetSiteDeploymentStatus.json
x-ms-long-running-operation: true
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments:
get:
operationId: WebApps_ListDeployments
tags:
- WebApps
summary: List deployments for an app, or a deployment slot.
description: Description for List deployments for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/DeploymentCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}:
get:
operationId: WebApps_GetDeployment
tags:
- WebApps
summary: Get a deployment by its ID for an app, or a deployment slot.
description: Description for Get a deployment by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: id
in: path
description: Deployment ID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Deployment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateDeployment
tags:
- WebApps
summary: Create a deployment for an app, or a deployment slot.
description: Description for Create a deployment for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: id
in: path
description: Deployment ID.
required: true
type: string
- name: deployment
in: body
description: Deployment details.
required: true
schema:
$ref: '#/definitions/Deployment'
responses:
'200':
description: Resource 'Deployment' update operation succeeded
schema:
$ref: '#/definitions/Deployment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteDeployment
tags:
- WebApps
summary: Delete a deployment by its ID for an app, or a deployment slot.
description: Description for Delete a deployment by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: id
in: path
description: Deployment ID.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log
: get:
operationId: WebApps_ListDeploymentLog
tags:
- WebApps
summary: List deployment log for specific deployment for an app, or a deployment slot.
description: Description for List deployment log for specific deployment for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: id
in: path
description: Deployment ID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Deployment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup:
post:
operationId: WebApps_DiscoverBackup
tags:
- WebApps
summary: Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.
description: Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: request
in: body
description: A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.
required: true
schema:
$ref: '#/definitions/RestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RestoreRequest'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers
: get:
operationId: WebApps_ListDomainOwnershipIdentifiers
tags:
- WebApps
summary: Lists ownership identifiers for domain associated with web app.
description: Description for Lists ownership identifiers for domain associated with web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/IdentifierCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
: get:
operationId: WebApps_GetDomainOwnershipIdentifier
tags:
- WebApps
summary: Get domain ownership identifier for web app.
description: Description for Get domain ownership identifier for web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: domainOwnershipIdentifierName
in: path
description: Name of domain ownership identifier.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Identifier'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateDomainOwnershipIdentifier
tags:
- WebApps
summary: Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
description: Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: domainOwnershipIdentifierName
in: path
description: Name of domain ownership identifier.
required: true
type: string
- name: domainOwnershipIdentifier
in: body
description: A JSON representation of the domain ownership properties.
required: true
schema:
$ref: '#/definitions/Identifier'
responses:
'200':
description: Resource 'Identifier' update operation succeeded
schema:
$ref: '#/definitions/Identifier'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateDomainOwnershipIdentifier
tags:
- WebApps
summary: Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
description: Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: domainOwnershipIdentifierName
in: path
description: Name of domain ownership identifier.
required: true
type: string
- name: domainOwnershipIdentifier
in: body
description: A JSON representation of the domain ownership properties.
required: true
schema:
$ref: '#/definitions/Identifier'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Identifier'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteDomainOwnershipIdentifier
tags:
- WebApps
summary: Deletes a domain ownership identifier for a web app.
description: Description for Deletes a domain ownership identifier for a web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: domainOwnershipIdentifierName
in: path
description: Name of domain ownership identifier.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy
: get:
operationId: WebApps_GetMSDeployStatus
tags:
- WebApps
summary: Get the status of the last MSDeploy operation.
description: Description for Get the status of the last MSDeploy operation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MSDeployStatus'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateMSDeployOperation
tags:
- WebApps
summary: Invoke the MSDeploy web app extension.
description: Description for Invoke the MSDeploy web app extension.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: MSDeploy
in: body
description: Details of MSDeploy operation
required: true
schema:
$ref: '#/definitions/MSDeploy'
responses:
'201':
description: Resource 'MSDeployStatus' create operation succeeded
schema:
$ref: '#/definitions/MSDeployStatus'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'409':
description: The request conflicts with the current state of the server.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/MSDeployStatus'
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log
: get:
operationId: WebApps_GetMSDeployLog
tags:
- WebApps
summary: Get the MSDeploy Log for the last MSDeploy operation.
description: Description for Get the MSDeploy Log for the last MSDeploy operation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MSDeployLog'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy
: get:
operationId: WebApps_GetOneDeployStatus
tags:
- WebApps
summary: Invoke onedeploy status API /api/deployments and gets the deployment status for the site
description: Description for Invoke onedeploy status API /api/deployments and gets the deployment status for the site
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema: {}
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOneDeployOperation
tags:
- WebApps
summary: Invoke the OneDeploy publish web app extension.
description: Description for Invoke the OneDeploy publish web app extension.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema: {}
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions:
get:
operationId: WebApps_ListFunctions
tags:
- WebApps
summary: List the functions for a web site, or a deployment slot.
description: Description for List the functions for a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/FunctionEnvelopeCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}
: get:
operationId: WebApps_GetFunction
tags:
- WebApps
summary: Get function information by its ID for web site, or a deployment slot.
description: Description for Get function information by its ID for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: functionName
in: path
description: Function name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/FunctionEnvelope'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateFunction
tags:
- WebApps
summary: Create function for web site, or a deployment slot.
description: Description for Create function for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: functionName
in: path
description: Function name.
required: true
type: string
- name: function_envelope
in: body
description: Function details.
required: true
schema:
$ref: '#/definitions/FunctionEnvelope'
responses:
'201':
description: Resource 'FunctionEnvelope' create operation succeeded
schema:
$ref: '#/definitions/FunctionEnvelope'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/FunctionEnvelope'
x-ms-long-running-operation: true
delete:
operationId: WebApps_DeleteFunction
tags:
- WebApps
summary: Delete a function for web site, or a deployment slot.
description: Description for Delete a function for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: functionName
in: path
description: Function name.
required: true
type: string
responses:
'204':
description: Resource does not exist.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listkeys
: post:
operationId: WebApps_ListFunctionKeys
tags:
- WebApps
summary: Get function keys for a function in a web site, or a deployment slot.
description: Description for Get function keys for a function in a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: functionName
in: path
description: Function name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets
: post:
operationId: WebApps_ListFunctionSecrets
tags:
- WebApps
summary: Get function secrets for a function in a web site, or a deployment slot.
description: Description for Get function secrets for a function in a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: functionName
in: path
description: Function name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/FunctionSecrets'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token
: get:
operationId: WebApps_GetFunctionsAdminToken
tags:
- WebApps
summary: Fetch a short lived token that can be exchanged for a master key.
description: Description for Fetch a short lived token that can be exchanged for a master key.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/stringApplicationJson'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys
: post:
operationId: WebApps_ListHostKeys
tags:
- WebApps
summary: Get host secrets for a function app.
description: Description for Get host secrets for a function app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HostKeys'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus
: post:
operationId: WebApps_ListSyncStatus
tags:
- WebApps
summary: This is to allow calling via powershell and ARM template.
description: Description for This is to allow calling via powershell and ARM template.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync:
post:
operationId: WebApps_SyncFunctions
tags:
- WebApps
summary: Syncs function trigger metadata to the management database
description: Description for Syncs function trigger metadata to the management database
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings:
get:
operationId: WebApps_ListHostNameBindings
tags:
- WebApps
summary: Get hostname bindings for an app or a deployment slot.
description: Description for Get hostname bindings for an app or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HostNameBindingCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}
: get:
operationId: WebApps_GetHostNameBinding
tags:
- WebApps
summary: Get the named hostname binding for an app (or deployment slot, if specified).
description: Description for Get the named hostname binding for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: hostName
in: path
description: Hostname in the hostname binding.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HostNameBinding'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateHostNameBinding
tags:
- WebApps
summary: Creates a hostname binding for an app.
description: Description for Creates a hostname binding for an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: hostName
in: path
description: Hostname in the hostname binding.
required: true
type: string
- name: hostNameBinding
in: body
description: Binding details. This is the JSON representation of a HostNameBinding object.
required: true
schema:
$ref: '#/definitions/HostNameBinding'
responses:
'200':
description: Resource 'HostNameBinding' update operation succeeded
schema:
$ref: '#/definitions/HostNameBinding'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteHostNameBinding
tags:
- WebApps
summary: Deletes a hostname binding for an app.
description: Description for Deletes a hostname binding for an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: hostName
in: path
description: Hostname in the hostname binding.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
: get:
operationId: WebApps_GetHybridConnection
tags:
- WebApps
summary: Retrieves a specific Service Bus Hybrid Connection used by this Web App.
description: Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: namespaceName
in: path
description: The namespace for this hybrid connection.
required: true
type: string
- name: relayName
in: path
description: The relay name for this hybrid connection.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HybridConnection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateHybridConnection
tags:
- WebApps
summary: Creates a new Hybrid Connection using a Service Bus relay.
description: Description for Creates a new Hybrid Connection using a Service Bus relay.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: namespaceName
in: path
description: The namespace for this hybrid connection.
required: true
type: string
- name: relayName
in: path
description: The relay name for this hybrid connection.
required: true
type: string
- name: connectionEnvelope
in: body
description: The details of the hybrid connection.
required: true
schema:
$ref: '#/definitions/HybridConnection'
responses:
'200':
description: Resource 'HybridConnection' update operation succeeded
schema:
$ref: '#/definitions/HybridConnection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateHybridConnection
tags:
- WebApps
summary: Creates a new Hybrid Connection using a Service Bus relay.
description: Description for Creates a new Hybrid Connection using a Service Bus relay.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: namespaceName
in: path
description: The namespace for this hybrid connection.
required: true
type: string
- name: relayName
in: path
description: The relay name for this hybrid connection.
required: true
type: string
- name: connectionEnvelope
in: body
description: The details of the hybrid connection.
required: true
schema:
$ref: '#/definitions/HybridConnection'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HybridConnection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteHybridConnection
tags:
- WebApps
summary: Removes a Hybrid Connection from this site.
description: Description for Removes a Hybrid Connection from this site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: namespaceName
in: path
description: The namespace for this hybrid connection.
required: true
type: string
- name: relayName
in: path
description: The relay name for this hybrid connection.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays
: get:
operationId: WebApps_ListHybridConnections
tags:
- WebApps
summary: Retrieves all Service Bus Hybrid Connections used by this Web App.
description: Description for Retrieves all Service Bus Hybrid Connections used by this Web App.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HybridConnection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection:
get:
operationId: WebApps_ListRelayServiceConnections
tags:
- WebApps
summary: Gets hybrid connections configured for an app (or deployment slot, if specified).
description: Description for Gets hybrid connections configured for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
: get:
operationId: WebApps_GetRelayServiceConnection
tags:
- WebApps
summary: Gets a hybrid connection configuration by its name.
description: Description for Gets a hybrid connection configuration by its name.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: entityName
in: path
description: Name of the hybrid connection.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateRelayServiceConnection
tags:
- WebApps
summary: Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
description: Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: entityName
in: path
description: Name of the hybrid connection.
required: true
type: string
- name: connectionEnvelope
in: body
description: Details of the hybrid connection configuration.
required: true
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
responses:
'200':
description: Resource 'RelayServiceConnectionEntity' update operation succeeded
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateRelayServiceConnection
tags:
- WebApps
summary: Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
description: Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: entityName
in: path
description: Name of the hybrid connection.
required: true
type: string
- name: connectionEnvelope
in: body
description: Details of the hybrid connection configuration.
required: true
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteRelayServiceConnection
tags:
- WebApps
summary: Deletes a relay service connection by its name.
description: Description for Deletes a relay service connection by its name.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: entityName
in: path
description: Name of the hybrid connection.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances:
get:
operationId: WebApps_ListInstanceIdentifiers
tags:
- WebApps
summary: Gets all scale-out instances of an app.
description: Description for Gets all scale-out instances of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebAppInstanceStatusCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}
: get:
operationId: WebApps_GetInstanceInfo
tags:
- WebApps
summary: Gets all scale-out instances of an app.
description: Description for Gets all scale-out instances of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: instanceId
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebSiteInstanceStatus'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get site instance info:
$ref: ./examples/GetSiteInstanceInfo.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy
: get:
operationId: WebApps_GetInstanceMsDeployStatus
tags:
- WebApps
summary: Get the status of the last MSDeploy operation.
description: Description for Get the status of the last MSDeploy operation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: instanceId
in: path
description: ID of web app instance.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MSDeployStatus'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateInstanceMSDeployOperation
tags:
- WebApps
summary: Invoke the MSDeploy web app extension.
description: Description for Invoke the MSDeploy web app extension.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: instanceId
in: path
description: ID of web app instance.
required: true
type: string
- name: MSDeploy
in: body
description: Details of MSDeploy operation
required: true
schema:
$ref: '#/definitions/MSDeploy'
responses:
'201':
description: Resource 'MSDeployStatus' create operation succeeded
schema:
$ref: '#/definitions/MSDeployStatus'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'409':
description: The request conflicts with the current state of the server.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/MSDeployStatus'
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log
: get:
operationId: WebApps_GetInstanceMSDeployLog
tags:
- WebApps
summary: Get the MSDeploy Log for the last MSDeploy operation.
description: Description for Get the MSDeploy Log for the last MSDeploy operation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: instanceId
in: path
description: ID of web app instance.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MSDeployLog'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes
: get:
operationId: WebApps_ListInstanceProcesses
tags:
- WebApps
summary: Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
description: Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}
: get:
operationId: WebApps_GetInstanceProcess
tags:
- WebApps
summary: Get process information by its ID for a specific scaled-out instance in a web site.
description: Description for Get process information by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteInstanceProcess
tags:
- WebApps
summary: Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
description: Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'204':
description: Resource does not exist.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump
: get:
operationId: WebApps_GetInstanceProcessDump
tags:
- WebApps
summary: Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
description: Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
produces:
- '*/*'
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules
: get:
operationId: WebApps_ListInstanceProcessModules
tags:
- WebApps
summary: List module information for a process by its ID for a specific scaled-out instance in a web site.
description: Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessModuleInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}
: get:
operationId: WebApps_GetInstanceProcessModule
tags:
- WebApps
summary: Get process information by its ID for a specific scaled-out instance in a web site.
description: Description for Get process information by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
- name: baseAddress
in: path
description: Module base address.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessModuleInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads
: get:
operationId: WebApps_ListInstanceProcessThreads
tags:
- WebApps
summary: List the threads in a process by its ID for a specific scaled-out instance in a web site.
description: Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessThreadInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable:
post:
operationId: WebApps_IsCloneable
tags:
- WebApps
summary: Shows whether an app can be cloned to another resource group or subscription.
description: Description for Shows whether an app can be cloned to another resource group or subscription.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteCloneability'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listWorkflowsConnections
: post:
operationId: WebApps_ListWorkflowsConnections
tags:
- WebApps
summary: Lists logic app's connections for web site, or a deployment slot.
description: Lists logic app's connections for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WorkflowEnvelope'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List the Instance Workflows Configuration Connections:
$ref: ./examples/ListWorkflowsConfigurationConnections.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listbackups:
post:
operationId: WebApps_ListSiteBackups
tags:
- WebApps
summary: Gets existing backups of an app.
description: Description for Gets existing backups of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItemCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List backups:
$ref: ./examples/ListSlotBackups.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus
: post:
operationId: WebApps_ListSyncFunctionTriggers
tags:
- WebApps
summary: This is to allow calling via powershell and ARM template.
description: Description for This is to allow calling via powershell and ARM template.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/FunctionSecrets'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate:
put:
operationId: WebApps_MigrateStorage
tags:
- WebApps
summary: Restores a web app.
description: Description for Restores a web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: subscriptionName
in: query
description: Azure subscription
required: true
type: string
- name: migrationOptions
in: body
description: Migration migrationOptions.
required: true
schema:
$ref: '#/definitions/StorageMigrationOptions'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/StorageMigrationResponse'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/StorageMigrationResponse'
x-ms-long-running-operation: true
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql:
post:
operationId: WebApps_MigrateMySql
tags:
- WebApps
summary: Migrates a local (in-app) MySql database to a remote MySql database.
description: Description for Migrates a local (in-app) MySql database to a remote MySql database.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: migrationRequestEnvelope
in: body
description: MySql migration options.
required: true
schema:
$ref: '#/definitions/MigrateMySqlRequest'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/Operation'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/Operation'
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status
: get:
operationId: WebApps_GetMigrateMySqlStatus
tags:
- WebApps
summary: Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
description: Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MigrateMySqlStatus'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork
: get:
operationId: WebApps_GetSwiftVirtualNetworkConnection
tags:
- WebApps
summary: Gets a Swift Virtual Network connection.
description: Description for Gets a Swift Virtual Network connection.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheck
tags:
- WebApps
summary: "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in."
description: 'Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not
in use by another App Service Plan other than the one this App is in.'
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: connectionEnvelope
in: body
description: Properties of the Virtual Network connection. See example.
required: true
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
responses:
'200':
description: Resource 'SwiftVirtualNetwork' update operation succeeded
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateSwiftVirtualNetworkConnectionWithCheck
tags:
- WebApps
summary: "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in."
description: 'Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not
in use by another App Service Plan other than the one this App is in.'
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: connectionEnvelope
in: body
description: Properties of the Virtual Network connection. See example.
required: true
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteSwiftVirtualNetwork
tags:
- WebApps
summary: Deletes a Swift Virtual Network connection from an app (or deployment slot).
description: Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}
: get:
operationId: WebApps_ListNetworkFeatures
tags:
- WebApps
summary: Gets all network features used by the app (or deployment slot, if specified).
description: Description for Gets all network features used by the app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: view
in: path
description: The type of view. Only "summary" is supported at this time.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/NetworkFeatures'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start:
post:
operationId: WebApps_StartWebSiteNetworkTrace
tags:
- WebApps
summary: Start capturing network packets for the site (To be deprecated).
description: Description for Start capturing network packets for the site (To be deprecated).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: durationInSeconds
in: query
description: The duration to keep capturing in seconds.
required: false
type: integer
format: int32
- name: maxFrameLength
in: query
description: The maximum frame length in bytes (Optional).
required: false
type: integer
format: int32
- name: sasUrl
in: query
description: The Blob URL to store capture file.
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/stringApplicationJson'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation
: post:
operationId: WebApps_StartWebSiteNetworkTraceOperation
tags:
- WebApps
summary: Start capturing network packets for the site.
description: Description for Start capturing network packets for the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: durationInSeconds
in: query
description: The duration to keep capturing in seconds.
required: false
type: integer
format: int32
- name: maxFrameLength
in: query
description: The maximum frame length in bytes (Optional).
required: false
type: integer
format: int32
- name: sasUrl
in: query
description: The Blob URL to store capture file.
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
'202':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Start a new network trace operation for a site:
$ref: ./examples/StartWebSiteNetworkTraceOperation.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop:
post:
operationId: WebApps_StopWebSiteNetworkTrace
tags:
- WebApps
summary: Stop ongoing capturing network packets for the site.
description: Description for Stop ongoing capturing network packets for the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Stop a currently running network trace operation for a site:
$ref: ./examples/StopWebSiteNetworkTrace.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword:
post:
operationId: WebApps_GenerateNewSitePublishingPassword
tags:
- WebApps
summary: Generates a new publishing password for an app (or deployment slot, if specified).
description: Description for Generates a new publishing password for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters:
get:
operationId: WebApps_ListPerfMonCounters
tags:
- WebApps
summary: Gets perfmon counters for web app.
description: Description for Gets perfmon counters for web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: $filter
in: query
description: 'Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration''[Hour|Minute|Day]''.'
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PerfMonCounterCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging:
get:
operationId: WebApps_GetSitePhpErrorLogFlag
tags:
- WebApps
summary: Gets web app's event logs.
description: Description for Gets web app's event logs.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SitePhpErrorLogFlag'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons:
get:
operationId: WebApps_ListPremierAddOns
tags:
- WebApps
summary: Gets the premier add-ons of an app.
description: Description for Gets the premier add-ons of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PremierAddOn'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}
: get:
operationId: WebApps_GetPremierAddOn
tags:
- WebApps
summary: Gets a named add-on of an app.
description: Description for Gets a named add-on of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: premierAddOnName
in: path
description: Add-on name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PremierAddOn'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_AddPremierAddOn
tags:
- WebApps
summary: Updates a named add-on of an app.
description: Description for Updates a named add-on of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: premierAddOnName
in: path
description: Add-on name.
required: true
type: string
- name: premierAddOn
in: body
description: A JSON representation of the edited premier add-on.
required: true
schema:
$ref: '#/definitions/PremierAddOn'
responses:
'200':
description: Resource 'PremierAddOn' update operation succeeded
schema:
$ref: '#/definitions/PremierAddOn'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdatePremierAddOn
tags:
- WebApps
summary: Updates a named add-on of an app.
description: Description for Updates a named add-on of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: premierAddOnName
in: path
description: Add-on name.
required: true
type: string
- name: premierAddOn
in: body
description: A JSON representation of the edited premier add-on.
required: true
schema:
$ref: '#/definitions/PremierAddOnPatchResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PremierAddOn'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeletePremierAddOn
tags:
- WebApps
summary: Delete a premier add-on from an app.
description: Description for Delete a premier add-on from an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: premierAddOnName
in: path
description: Add-on name.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks
: get:
operationId: WebApps_GetPrivateAccess
tags:
- WebApps
summary: Gets data around private site access enablement and authorized Virtual Networks that can access the site.
description: Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PrivateAccess'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_PutPrivateAccessVnet
tags:
- WebApps
summary: Sets data around private site access enablement and authorized Virtual Networks that can access the site.
description: Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: access
in: body
description: The information for the private access
required: true
schema:
$ref: '#/definitions/PrivateAccess'
responses:
'200':
description: Resource 'PrivateAccess' update operation succeeded
schema:
$ref: '#/definitions/PrivateAccess'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections
: get:
operationId: WebApps_GetPrivateEndpointConnectionList
tags:
- WebApps
summary: Gets the list of private endpoint connections associated with a site
description: Description for Gets the list of private endpoint connections associated with a site
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the site.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PrivateEndpointConnectionCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}
: get:
operationId: WebApps_GetPrivateEndpointConnection
tags:
- WebApps
summary: Gets a private endpoint connection
description: Description for Gets a private endpoint connection
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the site.
required: true
type: string
- name: privateEndpointConnectionName
in: path
description: Name of the private endpoint connection.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get a private endpoint connection for a site.:
$ref: ./examples/GetSitePrivateEndpointConnection.json
put:
operationId: WebApps_ApproveOrRejectPrivateEndpointConnection
tags:
- WebApps
summary: Approves or rejects a private endpoint connection
description: Description for Approves or rejects a private endpoint connection
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the site.
required: true
type: string
- name: privateEndpointConnectionName
in: path
description: Name of the private endpoint connection.
required: true
type: string
- name: privateEndpointWrapper
in: body
description: ''
required: true
schema:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
responses:
'200':
description: Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded
schema:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Approves or rejects a private endpoint connection for a site.:
$ref: ./examples/ApproveRejectSitePrivateEndpointConnection.json
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/RemotePrivateEndpointConnectionARMResource'
x-ms-long-running-operation: true
delete:
operationId: WebApps_DeletePrivateEndpointConnection
tags:
- WebApps
summary: Deletes a private endpoint connection
description: Description for Deletes a private endpoint connection
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the site.
required: true
type: string
- name: privateEndpointConnectionName
in: path
description: Name of the private endpoint connection.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema: {}
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema: {}
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
schema: {}
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Delete a private endpoint connection for a site.:
$ref: ./examples/DeleteSitePrivateEndpointConnection.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateLinkResources
: get:
operationId: WebApps_GetPrivateLinkResources
tags:
- WebApps
summary: Gets the private link resources
description: Description for Gets the private link resources
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PrivateLinkResourcesWrapper'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get private link resources of a site:
$ref: ./examples/GetSitePrivateLinkResources_WebApps.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes:
get:
operationId: WebApps_ListProcesses
tags:
- WebApps
summary: Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
description: Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}
: get:
operationId: WebApps_GetProcess
tags:
- WebApps
summary: Get process information by its ID for a specific scaled-out instance in a web site.
description: Description for Get process information by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteProcess
tags:
- WebApps
summary: Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
description: Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'204':
description: Resource does not exist.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump
: get:
operationId: WebApps_GetProcessDump
tags:
- WebApps
summary: Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
description: Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
produces:
- '*/*'
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules
: get:
operationId: WebApps_ListProcessModules
tags:
- WebApps
summary: List module information for a process by its ID for a specific scaled-out instance in a web site.
description: Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessModuleInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}
: get:
operationId: WebApps_GetProcessModule
tags:
- WebApps
summary: Get process information by its ID for a specific scaled-out instance in a web site.
description: Description for Get process information by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
- name: baseAddress
in: path
description: Module base address.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessModuleInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads
: get:
operationId: WebApps_ListProcessThreads
tags:
- WebApps
summary: List the threads in a process by its ID for a specific scaled-out instance in a web site.
description: Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessThreadInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates:
get:
operationId: WebApps_ListPublicCertificates
tags:
- WebApps
summary: Get public certificates for an app or a deployment slot.
description: Description for Get public certificates for an app or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PublicCertificateCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}
: get:
operationId: WebApps_GetPublicCertificate
tags:
- WebApps
summary: Get the named public certificate for an app (or deployment slot, if specified).
description: Description for Get the named public certificate for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: publicCertificateName
in: path
description: Public certificate name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PublicCertificate'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdatePublicCertificate
tags:
- WebApps
summary: Creates a hostname binding for an app.
description: Description for Creates a hostname binding for an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: publicCertificateName
in: path
description: Public certificate name.
required: true
type: string
- name: publicCertificate
in: body
description: Public certificate details. This is the JSON representation of a PublicCertificate object.
required: true
schema:
$ref: '#/definitions/PublicCertificate'
responses:
'200':
description: Resource 'PublicCertificate' update operation succeeded
schema:
$ref: '#/definitions/PublicCertificate'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeletePublicCertificate
tags:
- WebApps
summary: Deletes a hostname binding for an app.
description: Description for Deletes a hostname binding for an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: publicCertificateName
in: path
description: Public certificate name.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml:
post:
operationId: WebApps_ListPublishingProfileXmlWithSecrets
tags:
- WebApps
summary: Gets the publishing profile for an app (or deployment slot, if specified).
description: Description for Gets the publishing profile for an app (or deployment slot, if specified).
produces:
- application/xml
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: publishingProfileOptions
in: body
description: 'Specifies publishingProfileOptions for publishing profile. For example, use {" format": "FileZilla3"} to get a FileZilla publishing profile.'
required: true
schema:
$ref: '#/definitions/CsmPublishingProfileOptions'
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig:
post:
operationId: WebApps_ResetProductionSlotConfig
tags:
- WebApps
summary: Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
description: Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart:
post:
operationId: WebApps_Restart
tags:
- WebApps
summary: Restarts an app (or deployment slot, if specified).
description: Description for Restarts an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: softRestart
in: query
description: Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.
required: false
type: boolean
- name: synchronous
in: query
description: Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).
required: false
type: boolean
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob
: post:
operationId: WebApps_RestoreFromBackupBlob
tags:
- WebApps
summary: Restores an app from a backup blob in Azure Storage.
description: Description for Restores an app from a backup blob in Azure Storage.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: request
in: body
description: Information on restore request .
required: true
schema:
$ref: '#/definitions/RestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp
: post:
operationId: WebApps_RestoreFromDeletedApp
tags:
- WebApps
summary: Restores a deleted web app to this web app.
description: Description for Restores a deleted web app to this web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: restoreRequest
in: body
description: Deleted web app restore information.
required: true
schema:
$ref: '#/definitions/DeletedAppRestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot:
post:
operationId: WebApps_RestoreSnapshot
tags:
- WebApps
summary: Restores a web app from a snapshot.
description: Description for Restores a web app from a snapshot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: restoreRequest
in: body
description: Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.
required: true
schema:
$ref: '#/definitions/SnapshotRestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers:
get:
operationId: WebApps_ListSiteContainers
tags:
- WebApps
summary: Lists all the site containers of a site, or a deployment slot.
description: Lists all the site containers of a site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteContainerCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}
: get:
operationId: WebApps_GetSiteContainer
tags:
- WebApps
summary: Gets a site container of a site, or a deployment slot.
description: Gets a site container of a site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: containerName
in: path
description: Site Container Name
required: true
type: string
pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteContainer'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateSiteContainer
tags:
- WebApps
summary: Creates or Updates a site container for a site, or a deployment slot.
description: Creates or Updates a site container for a site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: containerName
in: path
description: Site Container Name
required: true
type: string
pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)
- name: request
in: body
description: Container Entity
required: true
schema:
$ref: '#/definitions/SiteContainer'
responses:
'200':
description: Resource 'SiteContainer' update operation succeeded
schema:
$ref: '#/definitions/SiteContainer'
'201':
description: Resource 'SiteContainer' create operation succeeded
schema:
$ref: '#/definitions/SiteContainer'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteSiteContainer
tags:
- WebApps
summary: Deletes a site container for a site, or a deployment slot.
description: Deletes a site container for a site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: containerName
in: path
description: Site Container Name
required: true
type: string
pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions:
get:
operationId: WebApps_ListSiteExtensions
tags:
- WebApps
summary: Get list of siteextensions for a web site, or a deployment slot.
description: Description for Get list of siteextensions for a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteExtensionInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}
: get:
operationId: WebApps_GetSiteExtension
tags:
- WebApps
summary: Get site extension information by its ID for a web site, or a deployment slot.
description: Description for Get site extension information by its ID for a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: siteExtensionId
in: path
description: Site extension name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteExtensionInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_InstallSiteExtension
tags:
- WebApps
summary: Install site extension on a web site, or a deployment slot.
description: Description for Install site extension on a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: siteExtensionId
in: path
description: Site extension name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteExtensionInfo'
'201':
description: Resource 'SiteExtensionInfo' create operation succeeded
schema:
$ref: '#/definitions/SiteExtensionInfo'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'429':
description: Client error
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/SiteExtensionInfo'
x-ms-long-running-operation: true
delete:
operationId: WebApps_DeleteSiteExtension
tags:
- WebApps
summary: Remove a site extension from a web site, or a deployment slot.
description: Description for Remove a site extension from a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: siteExtensionId
in: path
description: Site extension name.
required: true
type: string
responses:
'204':
description: Resource does not exist.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots:
get:
operationId: WebApps_ListSlots
tags:
- WebApps
summary: Gets an app's deployment slots.
description: Description for Gets an app's deployment slots.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebAppCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Web App Slots:
$ref: ./examples/ListWebAppSlots.json
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}:
get:
operationId: WebApps_GetSlot
tags:
- WebApps
summary: Gets the details of a web, mobile, or API app.
description: Description for Gets the details of a web, mobile, or API app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Site'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get Web App Slot:
$ref: ./examples/GetWebAppSlot.json
put:
operationId: WebApps_CreateOrUpdateSlot
tags:
- WebApps
summary: Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
description: Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: siteEnvelope
in: body
description: A JSON representation of the app properties. See example.
required: true
schema:
$ref: '#/definitions/Site'
responses:
'200':
description: Resource 'Site' update operation succeeded
schema:
$ref: '#/definitions/Site'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/Site'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Clone web app slot:
$ref: ./examples/CloneWebAppSlot.json
Create or Update Web App Slot:
$ref: ./examples/CreateOrUpdateWebAppSlot.json
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/Site'
x-ms-long-running-operation: true
patch:
operationId: WebApps_UpdateSlot
tags:
- WebApps
summary: Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
description: Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: siteEnvelope
in: body
description: A JSON representation of the app properties. See example.
required: true
schema:
$ref: '#/definitions/SitePatchResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Site'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/Site'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update Web App Slot:
$ref: ./examples/UpdateWebAppSlot.json
delete:
operationId: WebApps_DeleteSlot
tags:
- WebApps
summary: Deletes a web, mobile, or API app, or one of the deployment slots.
description: Description for Deletes a web, mobile, or API app, or one of the deployment slots.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: deleteMetrics
in: query
description: If true, web app metrics are also deleted.
required: false
type: boolean
- name: deleteEmptyServerFarm
in: query
description: Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.
required: false
type: boolean
responses:
'200':
description: The request has succeeded.
'204':
description: There is no content to send for this request, but the headers may be useful.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Delete Web App Slot:
$ref: ./examples/DeleteWebAppSlot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname
: get:
operationId: WebApps_AnalyzeCustomHostnameSlot
tags:
- WebApps
summary: Analyze a custom hostname.
description: Description for Analyze a custom hostname.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: hostName
in: query
description: Custom hostname.
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CustomHostnameAnalysisResult'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Analyze custom hostname for slot:
$ref: ./examples/AnalyzeCustomHostNameSlot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig
: post:
operationId: WebApps_ApplySlotConfigurationSlot
tags:
- WebApps
summary: Applies the configuration settings from the target slot onto the current slot.
description: Description for Applies the configuration settings from the target slot onto the current slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: slotSwapEntity
in: body
description: JSON object that contains the target slot name. See example.
required: true
schema:
$ref: '#/definitions/CsmSlotEntity'
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup
: post:
operationId: WebApps_BackupSlot
tags:
- WebApps
summary: Creates a backup of an app.
description: Description for Creates a backup of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: request
in: body
description: Backup configuration. You can use the JSON response from the POST action as input here.
required: true
schema:
$ref: '#/definitions/BackupRequest'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups
: get:
operationId: WebApps_ListBackupsSlot
tags:
- WebApps
summary: Gets existing backups of an app.
description: Description for Gets existing backups of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItemCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}
: get:
operationId: WebApps_GetBackupStatusSlot
tags:
- WebApps
summary: Gets a backup of an app by its ID.
description: Description for Gets a backup of an app by its ID.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.
required: true
type: string
- name: backupId
in: path
description: ID of the backup.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteBackupSlot
tags:
- WebApps
summary: Deletes a backup of an app by its ID.
description: Description for Deletes a backup of an app by its ID.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.
required: true
type: string
- name: backupId
in: path
description: ID of the backup.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list
: post:
operationId: WebApps_ListBackupStatusSecretsSlot
tags:
- WebApps
summary: Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
description: Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.
required: true
type: string
- name: backupId
in: path
description: ID of the backup.
required: true
type: string
- name: request
in: body
description: Information on backup request.
required: true
schema:
$ref: '#/definitions/BackupRequest'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItem'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore
: post:
operationId: WebApps_RestoreSlot
tags:
- WebApps
summary: Restores a specific backup to another app (or deployment slot, if specified).
description: Description for Restores a specific backup to another app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.
required: true
type: string
- name: backupId
in: path
description: ID of the backup.
required: true
type: string
- name: request
in: body
description: Information on restore request .
required: true
schema:
$ref: '#/definitions/RestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies
: get:
operationId: WebApps_ListBasicPublishingCredentialsPoliciesSlot
tags:
- WebApps
summary: Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
description: Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PublishingCredentialsPoliciesCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Publishing Credentials Policies:
$ref: ./examples/ListPublishingCredentialsPoliciesSlot.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/ftp
: get:
operationId: WebApps_GetFtpAllowedSlot
tags:
- WebApps
summary: Returns whether FTP is allowed on the site or not.
description: Description for Returns whether FTP is allowed on the site or not.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get FTP Allowed:
$ref: ./examples/GetPublishingCredentialsPolicySlot_FtpAllowedSlot.json
put:
operationId: WebApps_UpdateFtpAllowedSlot
tags:
- WebApps
summary: Updates whether FTP is allowed on the site or not.
description: Description for Updates whether FTP is allowed on the site or not.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
required: true
type: string
- name: csmPublishingAccessPoliciesEntity
in: body
description: ''
required: true
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
responses:
'200':
description: Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update FTP Allowed:
$ref: ./examples/UpdatePublishingCredentialsPolicySlot_UpdateFtpAllowedSlot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm
: get:
operationId: WebApps_GetScmAllowedSlot
tags:
- WebApps
summary: Returns whether Scm basic auth is allowed on the site or not.
description: Description for Returns whether Scm basic auth is allowed on the site or not.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get SCM Allowed:
$ref: ./examples/GetPublishingCredentialsPolicySlot.json
put:
operationId: WebApps_UpdateScmAllowedSlot
tags:
- WebApps
summary: Updates whether user publishing credentials are allowed on the site or not.
description: Description for Updates whether user publishing credentials are allowed on the site or not.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
required: true
type: string
- name: csmPublishingAccessPoliciesEntity
in: body
description: ''
required: true
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
responses:
'200':
description: Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded
schema:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Update SCM Allowed:
$ref: ./examples/UpdatePublishingCredentialsPolicySlot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config
: get:
operationId: WebApps_ListConfigurationsSlot
tags:
- WebApps
summary: List the configurations of an app
description: Description for List the configurations of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigResourceCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings
: put:
operationId: WebApps_UpdateApplicationSettingsSlot
tags:
- WebApps
summary: Replaces the application settings of an app.
description: Description for Replaces the application settings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: appSettings
in: body
description: Application settings of the app.
required: true
schema:
$ref: '#/definitions/StringDictionary'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list
: post:
operationId: WebApps_ListApplicationSettingsSlot
tags:
- WebApps
summary: Gets the application settings of an app.
description: Description for Gets the application settings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings
: put:
operationId: WebApps_UpdateAuthSettingsSlot
tags:
- WebApps
summary: Updates the Authentication / Authorization settings associated with web app.
description: Description for Updates the Authentication / Authorization settings associated with web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: siteAuthSettings
in: body
description: Auth settings associated with web app.
required: true
schema:
$ref: '#/definitions/SiteAuthSettings'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteAuthSettings'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list
: post:
operationId: WebApps_GetAuthSettingsSlot
tags:
- WebApps
summary: Gets the Authentication/Authorization settings of an app.
description: Description for Gets the Authentication/Authorization settings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteAuthSettings'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2
: get:
operationId: WebApps_GetAuthSettingsV2WithoutSecretsSlot
tags:
- WebApps
summary: Gets site's Authentication / Authorization settings for apps via the V2 format
description: Gets site's Authentication / Authorization settings for apps via the V2 format
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteAuthSettingsV2'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_UpdateAuthSettingsV2Slot
tags:
- WebApps
summary: Updates site's Authentication / Authorization settings for apps via the V2 format
description: Description for Updates site's Authentication / Authorization settings for apps via the V2 format
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.
required: true
type: string
- name: siteAuthSettingsV2
in: body
description: Auth settings associated with web app.
required: true
schema:
$ref: '#/definitions/SiteAuthSettingsV2'
responses:
'200':
description: Resource 'SiteAuthSettingsV2' update operation succeeded
schema:
$ref: '#/definitions/SiteAuthSettingsV2'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list
: get:
operationId: WebApps_GetAuthSettingsV2Slot
tags:
- WebApps
summary: Gets site's Authentication / Authorization settings for apps via the V2 format
description: Description for Gets site's Authentication / Authorization settings for apps via the V2 format
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteAuthSettingsV2'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts
: put:
operationId: WebApps_UpdateAzureStorageAccountsSlot
tags:
- WebApps
summary: Updates the Azure storage account configurations of an app.
description: Description for Updates the Azure storage account configurations of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: azureStorageAccounts
in: body
description: Azure storage accounts of the app.
required: true
schema:
$ref: '#/definitions/AzureStoragePropertyDictionaryResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/AzureStoragePropertyDictionaryResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list
: post:
operationId: WebApps_ListAzureStorageAccountsSlot
tags:
- WebApps
summary: Gets the Azure storage account configurations of an app.
description: Description for Gets the Azure storage account configurations of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/AzureStoragePropertyDictionaryResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup
: put:
operationId: WebApps_UpdateBackupConfigurationSlot
tags:
- WebApps
summary: Updates the backup configuration of an app.
description: Description for Updates the backup configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: request
in: body
description: Edited backup configuration.
required: true
schema:
$ref: '#/definitions/BackupRequest'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupRequest'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteBackupConfigurationSlot
tags:
- WebApps
summary: Deletes the backup configuration of an app.
description: Description for Deletes the backup configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list
: post:
operationId: WebApps_GetBackupConfigurationSlot
tags:
- WebApps
summary: Gets the backup configuration of an app.
description: Description for Gets the backup configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupRequest'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings
: get:
operationId: WebApps_GetAppSettingsKeyVaultReferencesSlot
tags:
- WebApps
summary: Gets the config reference app settings and status of an app
description: Description for Gets the config reference app settings and status of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ApiKVReferenceCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get Azure Key Vault references for app settings for slot:
$ref: ./examples/GetKeyVaultReferencesForAppSettingsSlot.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings/{appSettingKey}
: get:
operationId: WebApps_GetAppSettingKeyVaultReferenceSlot
tags:
- WebApps
summary: Gets the config reference and status of an app
description: Description for Gets the config reference and status of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
required: true
type: string
- name: appSettingKey
in: path
description: App Setting key name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ApiKVReference'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get Azure Key Vault slot app setting reference:
$ref: ./examples/GetKeyVaultReferencesForAppSettingSlot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings
: get:
operationId: WebApps_GetSiteConnectionStringKeyVaultReferencesSlot
tags:
- WebApps
summary: Gets the config reference app settings and status of an app
description: Description for Gets the config reference app settings and status of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ApiKVReferenceCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings/{connectionStringKey}
: get:
operationId: WebApps_GetSiteConnectionStringKeyVaultReferenceSlot
tags:
- WebApps
summary: Gets the config reference and status of an app
description: Description for Gets the config reference and status of an app
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
required: true
type: string
- name: connectionStringKey
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ApiKVReference'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings
: put:
operationId: WebApps_UpdateConnectionStringsSlot
tags:
- WebApps
summary: Replaces the connection strings of an app.
description: Description for Replaces the connection strings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: connectionStrings
in: body
description: Connection strings of the app or deployment slot. See example.
required: true
schema:
$ref: '#/definitions/ConnectionStringDictionary'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ConnectionStringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list
: post:
operationId: WebApps_ListConnectionStringsSlot
tags:
- WebApps
summary: Gets the connection strings of an app.
description: Description for Gets the connection strings of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ConnectionStringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs
: get:
operationId: WebApps_GetDiagnosticLogsConfigurationSlot
tags:
- WebApps
summary: Gets the logging configuration of an app.
description: Description for Gets the logging configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteLogsConfig'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_UpdateDiagnosticLogsConfigSlot
tags:
- WebApps
summary: Updates the logging configuration of an app.
description: Description for Updates the logging configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.
required: true
type: string
- name: siteLogsConfig
in: body
description: A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties"property
required: true
schema:
$ref: '#/definitions/SiteLogsConfig'
responses:
'200':
description: Resource 'SiteLogsConfig' update operation succeeded
schema:
$ref: '#/definitions/SiteLogsConfig'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata
: put:
operationId: WebApps_UpdateMetadataSlot
tags:
- WebApps
summary: Replaces the metadata of an app.
description: Description for Replaces the metadata of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: metadata
in: body
description: Edited metadata of the app or deployment slot. See example.
required: true
schema:
$ref: '#/definitions/StringDictionary'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list
: post:
operationId: WebApps_ListMetadataSlot
tags:
- WebApps
summary: Gets the metadata of an app.
description: Description for Gets the metadata of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list
: post:
operationId: WebApps_ListPublishingCredentialsSlot
tags:
- WebApps
summary: Gets the Git/FTP publishing credentials of an app.
description: Description for Gets the Git/FTP publishing credentials of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: If true, the password is included in the response. The default is false.
required: true
type: string
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/User'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/User'
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings
: put:
operationId: WebApps_UpdateSitePushSettingsSlot
tags:
- WebApps
summary: Updates the Push settings associated with web app.
description: Description for Updates the Push settings associated with web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: pushSettings
in: body
description: Push settings associated with web app.
required: true
schema:
$ref: '#/definitions/PushSettings'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PushSettings'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list
: post:
operationId: WebApps_ListSitePushSettingsSlot
tags:
- WebApps
summary: Gets the Push settings associated with web app.
description: Description for Gets the Push settings associated with web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PushSettings'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web
: get:
operationId: WebApps_GetConfigurationSlot
tags:
- WebApps
summary: Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
description: Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateConfigurationSlot
tags:
- WebApps
summary: Updates the configuration of an app.
description: Description for Updates the configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.
required: true
type: string
- name: siteConfig
in: body
description: JSON representation of a SiteConfig object. See example.
required: true
schema:
$ref: '#/definitions/SiteConfigResource'
responses:
'200':
description: Resource 'SiteConfigResource' update operation succeeded
schema:
$ref: '#/definitions/SiteConfigResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateConfigurationSlot
tags:
- WebApps
summary: Updates the configuration of an app.
description: Description for Updates the configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.
required: true
type: string
- name: siteConfig
in: body
description: JSON representation of a SiteConfig object. See example.
required: true
schema:
$ref: '#/definitions/SiteConfigResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots
: get:
operationId: WebApps_ListConfigurationSnapshotInfoSlot
tags:
- WebApps
summary: Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
description: Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigurationSnapshotInfoCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}
: get:
operationId: WebApps_GetConfigurationSnapshotSlot
tags:
- WebApps
summary: Gets a snapshot of the configuration of an app at a previous point in time.
description: Description for Gets a snapshot of the configuration of an app at a previous point in time.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.
required: true
type: string
- name: snapshotId
in: path
description: The ID of the snapshot to read.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteConfigResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover
: post:
operationId: WebApps_RecoverSiteConfigurationSnapshotSlot
tags:
- WebApps
summary: Reverts the configuration of an app to a previous snapshot.
description: Description for Reverts the configuration of an app to a previous snapshot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.
required: true
type: string
- name: snapshotId
in: path
description: The ID of the snapshot to read.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs
: post:
operationId: WebApps_GetWebSiteContainerLogsSlot
tags:
- WebApps
summary: Gets the last lines of docker logs for the given site
description: Description for Gets the last lines of docker logs for the given site
produces:
- application/octet-stream
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download
: post:
operationId: WebApps_GetContainerLogsZipSlot
tags:
- WebApps
summary: Gets the ZIP archived docker log files for the given site
description: Description for Gets the ZIP archived docker log files for the given site
produces:
- application/zip
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs
: get:
operationId: WebApps_ListContinuousWebJobsSlot
tags:
- WebApps
summary: List continuous web jobs for an app, or a deployment slot.
description: Description for List continuous web jobs for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ContinuousWebJobCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}
: get:
operationId: WebApps_GetContinuousWebJobSlot
tags:
- WebApps
summary: Gets a continuous web job by its ID for an app, or a deployment slot.
description: Description for Gets a continuous web job by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ContinuousWebJob'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteContinuousWebJobSlot
tags:
- WebApps
summary: Delete a continuous web job by its ID for an app, or a deployment slot.
description: Description for Delete a continuous web job by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start
: post:
operationId: WebApps_StartContinuousWebJobSlot
tags:
- WebApps
summary: Start a continuous web job for an app, or a deployment slot.
description: Description for Start a continuous web job for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop
: post:
operationId: WebApps_StopContinuousWebJobSlot
tags:
- WebApps
summary: Stop a continuous web job for an app, or a deployment slot.
description: Description for Stop a continuous web job for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployWorkflowArtifacts
: post:
operationId: WebApps_DeployWorkflowArtifactsSlot
tags:
- WebApps
summary: Creates the artifacts for web site, or a deployment slot.
description: Description for Creates the artifacts for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: workflowArtifacts
in: body
description: Application settings and files of the workflow.
required: false
schema:
$ref: '#/definitions/WorkflowArtifacts'
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Deploys workflow artifacts slot:
$ref: ./examples/PostDeployWorkflowArtifactsSlot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus
: get:
operationId: WebApps_ListSlotSiteDeploymentStatusesSlot
tags:
- WebApps
summary: List deployment statuses for an app (or deployment slot, if specified).
description: List deployment statuses for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmDeploymentStatusCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List Deployment Status Slot:
$ref: ./examples/ListSiteDeploymentStatusSlot.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus/{deploymentStatusId}
: get:
operationId: WebApps_GetSlotSiteDeploymentStatusSlot
tags:
- WebApps
summary: Gets the deployment status for an app (or deployment slot, if specified).
description: Gets the deployment status for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot.
required: true
type: string
- name: deploymentStatusId
in: path
description: GUID of the deployment operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmDeploymentStatus'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/CsmDeploymentStatus'
headers:
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get Deployment Status Slot:
$ref: ./examples/GetSiteDeploymentStatusSlot.json
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments
: get:
operationId: WebApps_ListDeploymentsSlot
tags:
- WebApps
summary: List deployments for an app, or a deployment slot.
description: Description for List deployments for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/DeploymentCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}
: get:
operationId: WebApps_GetDeploymentSlot
tags:
- WebApps
summary: Get a deployment by its ID for an app, or a deployment slot.
description: Description for Get a deployment by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.
required: true
type: string
- name: id
in: path
description: Deployment ID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Deployment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateDeploymentSlot
tags:
- WebApps
summary: Create a deployment for an app, or a deployment slot.
description: Description for Create a deployment for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.
required: true
type: string
- name: id
in: path
description: Deployment ID.
required: true
type: string
- name: deployment
in: body
description: Deployment details.
required: true
schema:
$ref: '#/definitions/Deployment'
responses:
'200':
description: Resource 'Deployment' update operation succeeded
schema:
$ref: '#/definitions/Deployment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteDeploymentSlot
tags:
- WebApps
summary: Delete a deployment by its ID for an app, or a deployment slot.
description: Description for Delete a deployment by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.
required: true
type: string
- name: id
in: path
description: Deployment ID.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log
: get:
operationId: WebApps_ListDeploymentLogSlot
tags:
- WebApps
summary: List deployment log for specific deployment for an app, or a deployment slot.
description: Description for List deployment log for specific deployment for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.
required: true
type: string
- name: id
in: path
description: Deployment ID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Deployment'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup
: post:
operationId: WebApps_DiscoverBackupSlot
tags:
- WebApps
summary: Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.
description: Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: request
in: body
description: A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.
required: true
schema:
$ref: '#/definitions/RestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RestoreRequest'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers
: get:
operationId: WebApps_ListDomainOwnershipIdentifiersSlot
tags:
- WebApps
summary: Lists ownership identifiers for domain associated with web app.
description: Description for Lists ownership identifiers for domain associated with web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/IdentifierCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}
: get:
operationId: WebApps_GetDomainOwnershipIdentifierSlot
tags:
- WebApps
summary: Get domain ownership identifier for web app.
description: Description for Get domain ownership identifier for web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.
required: true
type: string
- name: domainOwnershipIdentifierName
in: path
description: Name of domain ownership identifier.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Identifier'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot
tags:
- WebApps
summary: Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
description: Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.
required: true
type: string
- name: domainOwnershipIdentifierName
in: path
description: Name of domain ownership identifier.
required: true
type: string
- name: domainOwnershipIdentifier
in: body
description: A JSON representation of the domain ownership properties.
required: true
schema:
$ref: '#/definitions/Identifier'
responses:
'200':
description: Resource 'Identifier' update operation succeeded
schema:
$ref: '#/definitions/Identifier'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateDomainOwnershipIdentifierSlot
tags:
- WebApps
summary: Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
description: Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.
required: true
type: string
- name: domainOwnershipIdentifierName
in: path
description: Name of domain ownership identifier.
required: true
type: string
- name: domainOwnershipIdentifier
in: body
description: A JSON representation of the domain ownership properties.
required: true
schema:
$ref: '#/definitions/Identifier'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/Identifier'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteDomainOwnershipIdentifierSlot
tags:
- WebApps
summary: Deletes a domain ownership identifier for a web app.
description: Description for Deletes a domain ownership identifier for a web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.
required: true
type: string
- name: domainOwnershipIdentifierName
in: path
description: Name of domain ownership identifier.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy
: get:
operationId: WebApps_GetMSDeployStatusSlot
tags:
- WebApps
summary: Get the status of the last MSDeploy operation.
description: Description for Get the status of the last MSDeploy operation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: slot
in: path
description: Name of web app slot. If not specified then will default to production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MSDeployStatus'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateMSDeployOperationSlot
tags:
- WebApps
summary: Invoke the MSDeploy web app extension.
description: Description for Invoke the MSDeploy web app extension.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: slot
in: path
description: Name of web app slot. If not specified then will default to production slot.
required: true
type: string
- name: MSDeploy
in: body
description: Details of MSDeploy operation
required: true
schema:
$ref: '#/definitions/MSDeploy'
responses:
'201':
description: Resource 'MSDeployStatus' create operation succeeded
schema:
$ref: '#/definitions/MSDeployStatus'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'409':
description: The request conflicts with the current state of the server.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/MSDeployStatus'
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log
: get:
operationId: WebApps_GetMSDeployLogSlot
tags:
- WebApps
summary: Get the MSDeploy Log for the last MSDeploy operation.
description: Description for Get the MSDeploy Log for the last MSDeploy operation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: slot
in: path
description: Name of web app slot. If not specified then will default to production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MSDeployLog'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions
: get:
operationId: WebApps_ListInstanceFunctionsSlot
tags:
- WebApps
summary: List the functions for a web site, or a deployment slot.
description: Description for List the functions for a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/FunctionEnvelopeCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}
: get:
operationId: WebApps_GetInstanceFunctionSlot
tags:
- WebApps
summary: Get function information by its ID for web site, or a deployment slot.
description: Description for Get function information by its ID for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot.
required: true
type: string
- name: functionName
in: path
description: Function name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/FunctionEnvelope'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateInstanceFunctionSlot
tags:
- WebApps
summary: Create function for web site, or a deployment slot.
description: Description for Create function for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot.
required: true
type: string
- name: functionName
in: path
description: Function name.
required: true
type: string
- name: function_envelope
in: body
description: Function details.
required: true
schema:
$ref: '#/definitions/FunctionEnvelope'
responses:
'201':
description: Resource 'FunctionEnvelope' create operation succeeded
schema:
$ref: '#/definitions/FunctionEnvelope'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/FunctionEnvelope'
x-ms-long-running-operation: true
delete:
operationId: WebApps_DeleteInstanceFunctionSlot
tags:
- WebApps
summary: Delete a function for web site, or a deployment slot.
description: Description for Delete a function for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot.
required: true
type: string
- name: functionName
in: path
description: Function name.
required: true
type: string
responses:
'204':
description: Resource does not exist.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}
: put:
operationId: WebApps_CreateOrUpdateFunctionSecretSlot
tags:
- WebApps
summary: Add or update a function secret.
description: Description for Add or update a function secret.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
required: true
type: string
- name: slot
in: path
required: true
type: string
- name: functionName
in: path
required: true
type: string
- name: keyName
in: path
required: true
type: string
- name: key
in: body
description: The key to create or update
required: true
schema:
$ref: '#/definitions/KeyInfo'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/KeyInfo'
'201':
description: Resource 'KeyInfo' create operation succeeded
schema:
$ref: '#/definitions/KeyInfo'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteFunctionSecretSlot
tags:
- WebApps
summary: Delete a function secret.
description: Description for Delete a function secret.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
required: true
type: string
- name: slot
in: path
required: true
type: string
- name: functionName
in: path
required: true
type: string
- name: keyName
in: path
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys
: post:
operationId: WebApps_ListFunctionKeysSlot
tags:
- WebApps
summary: Get function keys for a function in a web site, or a deployment slot.
description: Description for Get function keys for a function in a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
required: true
type: string
- name: slot
in: path
required: true
type: string
- name: functionName
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/StringDictionary'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets
: post:
operationId: WebApps_ListFunctionSecretsSlot
tags:
- WebApps
summary: Get function secrets for a function in a web site, or a deployment slot.
description: Description for Get function secrets for a function in a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot.
required: true
type: string
- name: functionName
in: path
description: Function name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/FunctionSecrets'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token
: get:
operationId: WebApps_GetFunctionsAdminTokenSlot
tags:
- WebApps
summary: Fetch a short lived token that can be exchanged for a master key.
description: Description for Fetch a short lived token that can be exchanged for a master key.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/stringApplicationJson'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys
: post:
operationId: WebApps_ListHostKeysSlot
tags:
- WebApps
summary: Get host secrets for a function app.
description: Description for Get host secrets for a function app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HostKeys'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus
: post:
operationId: WebApps_ListSyncStatusSlot
tags:
- WebApps
summary: This is to allow calling via powershell and ARM template.
description: Description for This is to allow calling via powershell and ARM template.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync
: post:
operationId: WebApps_SyncFunctionsSlot
tags:
- WebApps
summary: Syncs function trigger metadata to the management database
description: Description for Syncs function trigger metadata to the management database
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings
: get:
operationId: WebApps_ListHostNameBindingsSlot
tags:
- WebApps
summary: Get hostname bindings for an app or a deployment slot.
description: Description for Get hostname bindings for an app or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HostNameBindingCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}
: get:
operationId: WebApps_GetHostNameBindingSlot
tags:
- WebApps
summary: Get the named hostname binding for an app (or deployment slot, if specified).
description: Description for Get the named hostname binding for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.
required: true
type: string
- name: hostName
in: path
description: Hostname in the hostname binding.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HostNameBinding'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateHostNameBindingSlot
tags:
- WebApps
summary: Creates a hostname binding for an app.
description: Description for Creates a hostname binding for an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.
required: true
type: string
- name: hostName
in: path
description: Hostname in the hostname binding.
required: true
type: string
- name: hostNameBinding
in: body
description: Binding details. This is the JSON representation of a HostNameBinding object.
required: true
schema:
$ref: '#/definitions/HostNameBinding'
responses:
'200':
description: Resource 'HostNameBinding' update operation succeeded
schema:
$ref: '#/definitions/HostNameBinding'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteHostNameBindingSlot
tags:
- WebApps
summary: Deletes a hostname binding for an app.
description: Description for Deletes a hostname binding for an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.
required: true
type: string
- name: hostName
in: path
description: Hostname in the hostname binding.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
: get:
operationId: WebApps_GetHybridConnectionSlot
tags:
- WebApps
summary: Retrieves a specific Service Bus Hybrid Connection used by this Web App.
description: Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: slot
in: path
description: The name of the slot for the web app.
required: true
type: string
- name: namespaceName
in: path
description: The namespace for this hybrid connection.
required: true
type: string
- name: relayName
in: path
description: The relay name for this hybrid connection.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HybridConnection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateHybridConnectionSlot
tags:
- WebApps
summary: Creates a new Hybrid Connection using a Service Bus relay.
description: Description for Creates a new Hybrid Connection using a Service Bus relay.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: slot
in: path
description: The name of the slot for the web app.
required: true
type: string
- name: namespaceName
in: path
description: The namespace for this hybrid connection.
required: true
type: string
- name: relayName
in: path
description: The relay name for this hybrid connection.
required: true
type: string
- name: connectionEnvelope
in: body
description: The details of the hybrid connection.
required: true
schema:
$ref: '#/definitions/HybridConnection'
responses:
'200':
description: Resource 'HybridConnection' update operation succeeded
schema:
$ref: '#/definitions/HybridConnection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateHybridConnectionSlot
tags:
- WebApps
summary: Creates a new Hybrid Connection using a Service Bus relay.
description: Description for Creates a new Hybrid Connection using a Service Bus relay.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: slot
in: path
description: The name of the slot for the web app.
required: true
type: string
- name: namespaceName
in: path
description: The namespace for this hybrid connection.
required: true
type: string
- name: relayName
in: path
description: The relay name for this hybrid connection.
required: true
type: string
- name: connectionEnvelope
in: body
description: The details of the hybrid connection.
required: true
schema:
$ref: '#/definitions/HybridConnection'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HybridConnection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteHybridConnectionSlot
tags:
- WebApps
summary: Removes a Hybrid Connection from this site.
description: Description for Removes a Hybrid Connection from this site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: slot
in: path
description: The name of the slot for the web app.
required: true
type: string
- name: namespaceName
in: path
description: The namespace for this hybrid connection.
required: true
type: string
- name: relayName
in: path
description: The relay name for this hybrid connection.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays
: get:
operationId: WebApps_ListHybridConnectionsSlot
tags:
- WebApps
summary: Retrieves all Service Bus Hybrid Connections used by this Web App.
description: Description for Retrieves all Service Bus Hybrid Connections used by this Web App.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/HybridConnection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection
: get:
operationId: WebApps_ListRelayServiceConnectionsSlot
tags:
- WebApps
summary: Gets hybrid connections configured for an app (or deployment slot, if specified).
description: Description for Gets hybrid connections configured for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}
: get:
operationId: WebApps_GetRelayServiceConnectionSlot
tags:
- WebApps
summary: Gets a hybrid connection configuration by its name.
description: Description for Gets a hybrid connection configuration by its name.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.
required: true
type: string
- name: entityName
in: path
description: Name of the hybrid connection.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateRelayServiceConnectionSlot
tags:
- WebApps
summary: Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
description: Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.
required: true
type: string
- name: entityName
in: path
description: Name of the hybrid connection.
required: true
type: string
- name: connectionEnvelope
in: body
description: Details of the hybrid connection configuration.
required: true
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
responses:
'200':
description: Resource 'RelayServiceConnectionEntity' update operation succeeded
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateRelayServiceConnectionSlot
tags:
- WebApps
summary: Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
description: Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.
required: true
type: string
- name: entityName
in: path
description: Name of the hybrid connection.
required: true
type: string
- name: connectionEnvelope
in: body
description: Details of the hybrid connection configuration.
required: true
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RelayServiceConnectionEntity'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteRelayServiceConnectionSlot
tags:
- WebApps
summary: Deletes a relay service connection by its name.
description: Description for Deletes a relay service connection by its name.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.
required: true
type: string
- name: entityName
in: path
description: Name of the hybrid connection.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances
: get:
operationId: WebApps_ListInstanceIdentifiersSlot
tags:
- WebApps
summary: Gets all scale-out instances of an app.
description: Description for Gets all scale-out instances of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebAppInstanceStatusCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}
: get:
operationId: WebApps_GetInstanceInfoSlot
tags:
- WebApps
summary: Gets all scale-out instances of an app.
description: Description for Gets all scale-out instances of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.
required: true
type: string
- name: instanceId
in: path
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebSiteInstanceStatus'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get site instance info:
$ref: ./examples/GetSiteInstanceInfo_Slot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy
: get:
operationId: WebApps_GetInstanceMsDeployStatusSlot
tags:
- WebApps
summary: Get the status of the last MSDeploy operation.
description: Description for Get the status of the last MSDeploy operation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: slot
in: path
description: Name of web app slot. If not specified then will default to production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of web app instance.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MSDeployStatus'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateInstanceMSDeployOperationSlot
tags:
- WebApps
summary: Invoke the MSDeploy web app extension.
description: Description for Invoke the MSDeploy web app extension.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: slot
in: path
description: Name of web app slot. If not specified then will default to production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of web app instance.
required: true
type: string
- name: MSDeploy
in: body
description: Details of MSDeploy operation
required: true
schema:
$ref: '#/definitions/MSDeploy'
responses:
'201':
description: Resource 'MSDeployStatus' create operation succeeded
schema:
$ref: '#/definitions/MSDeployStatus'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'409':
description: The request conflicts with the current state of the server.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/MSDeployStatus'
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log
: get:
operationId: WebApps_GetInstanceMSDeployLogSlot
tags:
- WebApps
summary: Get the MSDeploy Log for the last MSDeploy operation.
description: Description for Get the MSDeploy Log for the last MSDeploy operation.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: slot
in: path
description: Name of web app slot. If not specified then will default to production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of web app instance.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MSDeployLog'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes
: get:
operationId: WebApps_ListInstanceProcessesSlot
tags:
- WebApps
summary: Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
description: Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}
: get:
operationId: WebApps_GetInstanceProcessSlot
tags:
- WebApps
summary: Get process information by its ID for a specific scaled-out instance in a web site.
description: Description for Get process information by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteInstanceProcessSlot
tags:
- WebApps
summary: Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
description: Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'204':
description: Resource does not exist.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump
: get:
operationId: WebApps_GetInstanceProcessDumpSlot
tags:
- WebApps
summary: Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
description: Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
produces:
- '*/*'
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules
: get:
operationId: WebApps_ListInstanceProcessModulesSlot
tags:
- WebApps
summary: List module information for a process by its ID for a specific scaled-out instance in a web site.
description: Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessModuleInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}
: get:
operationId: WebApps_GetInstanceProcessModuleSlot
tags:
- WebApps
summary: Get process information by its ID for a specific scaled-out instance in a web site.
description: Description for Get process information by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
- name: baseAddress
in: path
description: Module base address.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessModuleInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads
: get:
operationId: WebApps_ListInstanceProcessThreadsSlot
tags:
- WebApps
summary: List the threads in a process by its ID for a specific scaled-out instance in a web site.
description: Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: instanceId
in: path
description: ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances".
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessThreadInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable
: post:
operationId: WebApps_IsCloneableSlot
tags:
- WebApps
summary: Shows whether an app can be cloned to another resource group or subscription.
description: Description for Shows whether an app can be cloned to another resource group or subscription.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteCloneability'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listWorkflowsConnections
: post:
operationId: WebApps_ListWorkflowsConnectionsSlot
tags:
- WebApps
summary: Lists logic app's connections for web site, or a deployment slot.
description: Lists logic app's connections for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WorkflowEnvelope'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List the Instance Workflows Configuration Connections Slot:
$ref: ./examples/ListWorkflowsConfigurationConnections_Slot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listbackups
: post:
operationId: WebApps_ListSiteBackupsSlot
tags:
- WebApps
summary: Gets existing backups of an app.
description: Description for Gets existing backups of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/BackupItemCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List backups:
$ref: ./examples/ListSiteBackupsSlot.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus
: post:
operationId: WebApps_ListSyncFunctionTriggersSlot
tags:
- WebApps
summary: This is to allow calling via powershell and ARM template.
description: Description for This is to allow calling via powershell and ARM template.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/FunctionSecrets'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status
: get:
operationId: WebApps_GetMigrateMySqlStatusSlot
tags:
- WebApps
summary: Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
description: Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of web app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/MigrateMySqlStatus'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork
: get:
operationId: WebApps_GetSwiftVirtualNetworkConnectionSlot
tags:
- WebApps
summary: Gets a Swift Virtual Network connection.
description: Description for Gets a Swift Virtual Network connection.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheckSlot
tags:
- WebApps
summary: "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in."
description: 'Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not
in use by another App Service Plan other than the one this App is in.'
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.
required: true
type: string
- name: connectionEnvelope
in: body
description: Properties of the Virtual Network connection. See example.
required: true
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
responses:
'200':
description: Resource 'SwiftVirtualNetwork' update operation succeeded
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateSwiftVirtualNetworkConnectionWithCheckSlot
tags:
- WebApps
summary: "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in."
description: 'Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not
in use by another App Service Plan other than the one this App is in.'
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.
required: true
type: string
- name: connectionEnvelope
in: body
description: Properties of the Virtual Network connection. See example.
required: true
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SwiftVirtualNetwork'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteSwiftVirtualNetworkSlot
tags:
- WebApps
summary: Deletes a Swift Virtual Network connection from an app (or deployment slot).
description: Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}
: get:
operationId: WebApps_ListNetworkFeaturesSlot
tags:
- WebApps
summary: Gets all network features used by the app (or deployment slot, if specified).
description: Description for Gets all network features used by the app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.
required: true
type: string
- name: view
in: path
description: The type of view. Only "summary" is supported at this time.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/NetworkFeatures'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start
: post:
operationId: WebApps_StartWebSiteNetworkTraceSlot
tags:
- WebApps
summary: Start capturing network packets for the site (To be deprecated).
description: Description for Start capturing network packets for the site (To be deprecated).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: durationInSeconds
in: query
description: The duration to keep capturing in seconds.
required: false
type: integer
format: int32
- name: maxFrameLength
in: query
description: The maximum frame length in bytes (Optional).
required: false
type: integer
format: int32
- name: sasUrl
in: query
description: The Blob URL to store capture file.
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/stringApplicationJson'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/startOperation
: post:
operationId: WebApps_StartWebSiteNetworkTraceOperationSlot
tags:
- WebApps
summary: Start capturing network packets for the site.
description: Description for Start capturing network packets for the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: durationInSeconds
in: query
description: The duration to keep capturing in seconds.
required: false
type: integer
format: int32
- name: maxFrameLength
in: query
description: The maximum frame length in bytes (Optional).
required: false
type: integer
format: int32
- name: sasUrl
in: query
description: The Blob URL to store capture file.
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
'202':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Start a new network trace operation for a site:
$ref: ./examples/StartWebSiteNetworkTraceOperation_Slot.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop
: post:
operationId: WebApps_StopWebSiteNetworkTraceSlot
tags:
- WebApps
summary: Stop ongoing capturing network packets for the site.
description: Description for Stop ongoing capturing network packets for the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Stop a currently running network trace operation for a site:
$ref: ./examples/StopWebSiteNetworkTrace_Slot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword
: post:
operationId: WebApps_GenerateNewSitePublishingPasswordSlot
tags:
- WebApps
summary: Generates a new publishing password for an app (or deployment slot, if specified).
description: Description for Generates a new publishing password for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters
: get:
operationId: WebApps_ListPerfMonCountersSlot
tags:
- WebApps
summary: Gets perfmon counters for web app.
description: Description for Gets perfmon counters for web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: $filter
in: query
description: 'Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration''[Hour|Minute|Day]''.'
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PerfMonCounterCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging
: get:
operationId: WebApps_GetSitePhpErrorLogFlagSlot
tags:
- WebApps
summary: Gets web app's event logs.
description: Description for Gets web app's event logs.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SitePhpErrorLogFlag'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons
: get:
operationId: WebApps_ListPremierAddOnsSlot
tags:
- WebApps
summary: Gets the premier add-ons of an app.
description: Description for Gets the premier add-ons of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PremierAddOn'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}
: get:
operationId: WebApps_GetPremierAddOnSlot
tags:
- WebApps
summary: Gets a named add-on of an app.
description: Description for Gets a named add-on of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.
required: true
type: string
- name: premierAddOnName
in: path
description: Add-on name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PremierAddOn'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_AddPremierAddOnSlot
tags:
- WebApps
summary: Updates a named add-on of an app.
description: Description for Updates a named add-on of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.
required: true
type: string
- name: premierAddOnName
in: path
description: Add-on name.
required: true
type: string
- name: premierAddOn
in: body
description: A JSON representation of the edited premier add-on.
required: true
schema:
$ref: '#/definitions/PremierAddOn'
responses:
'200':
description: Resource 'PremierAddOn' update operation succeeded
schema:
$ref: '#/definitions/PremierAddOn'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdatePremierAddOnSlot
tags:
- WebApps
summary: Updates a named add-on of an app.
description: Description for Updates a named add-on of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.
required: true
type: string
- name: premierAddOnName
in: path
description: Add-on name.
required: true
type: string
- name: premierAddOn
in: body
description: A JSON representation of the edited premier add-on.
required: true
schema:
$ref: '#/definitions/PremierAddOnPatchResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PremierAddOn'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeletePremierAddOnSlot
tags:
- WebApps
summary: Delete a premier add-on from an app.
description: Description for Delete a premier add-on from an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.
required: true
type: string
- name: premierAddOnName
in: path
description: Add-on name.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks
: get:
operationId: WebApps_GetPrivateAccessSlot
tags:
- WebApps
summary: Gets data around private site access enablement and authorized Virtual Networks that can access the site.
description: Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: slot
in: path
description: The name of the slot for the web app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PrivateAccess'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_PutPrivateAccessVnetSlot
tags:
- WebApps
summary: Sets data around private site access enablement and authorized Virtual Networks that can access the site.
description: Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: The name of the web app.
required: true
type: string
- name: slot
in: path
description: The name of the slot for the web app.
required: true
type: string
- name: access
in: body
description: The information for the private access
required: true
schema:
$ref: '#/definitions/PrivateAccess'
responses:
'200':
description: Resource 'PrivateAccess' update operation succeeded
schema:
$ref: '#/definitions/PrivateAccess'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections
: get:
operationId: WebApps_GetPrivateEndpointConnectionListSlot
tags:
- WebApps
summary: Gets the list of private endpoint connections associated with a site
description: Description for Gets the list of private endpoint connections associated with a site
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the site.
required: true
type: string
- name: slot
in: path
description: Name of the site deployment slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PrivateEndpointConnectionCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}
: get:
operationId: WebApps_GetPrivateEndpointConnectionSlot
tags:
- WebApps
summary: Gets a private endpoint connection
description: Description for Gets a private endpoint connection
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the site.
required: true
type: string
- name: slot
in: path
description: Name of the site deployment slot.
required: true
type: string
- name: privateEndpointConnectionName
in: path
description: Name of the private endpoint connection.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get a private endpoint connection for a site.:
$ref: ./examples/GetSitePrivateEndpointConnectionSlot.json
put:
operationId: WebApps_ApproveOrRejectPrivateEndpointConnectionSlot
tags:
- WebApps
summary: Approves or rejects a private endpoint connection
description: Description for Approves or rejects a private endpoint connection
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the site.
required: true
type: string
- name: slot
in: path
description: Name of the site deployment slot.
required: true
type: string
- name: privateEndpointConnectionName
in: path
description: Name of the private endpoint connection.
required: true
type: string
- name: privateEndpointWrapper
in: body
description: ''
required: true
schema:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
responses:
'200':
description: Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded
schema:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Approves or rejects a private endpoint connection for a site.:
$ref: ./examples/ApproveRejectSitePrivateEndpointConnectionSlot.json
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/RemotePrivateEndpointConnectionARMResource'
x-ms-long-running-operation: true
delete:
operationId: WebApps_DeletePrivateEndpointConnectionSlot
tags:
- WebApps
summary: Deletes a private endpoint connection
description: Description for Deletes a private endpoint connection
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the site.
required: true
type: string
- name: slot
in: path
description: Name of the site deployment slot.
required: true
type: string
- name: privateEndpointConnectionName
in: path
description: Name of the private endpoint connection.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema: {}
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema: {}
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
schema: {}
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Delete a private endpoint connection for a site.:
$ref: ./examples/DeleteSitePrivateEndpointConnectionSlot.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateLinkResources
: get:
operationId: WebApps_GetPrivateLinkResourcesSlot
tags:
- WebApps
summary: Gets the private link resources
description: Description for Gets the private link resources
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PrivateLinkResourcesWrapper'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get private link resources of a site:
$ref: ./examples/GetSitePrivateLinkResourcesSlot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes
: get:
operationId: WebApps_ListProcessesSlot
tags:
- WebApps
summary: Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
description: Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}
: get:
operationId: WebApps_GetProcessSlot
tags:
- WebApps
summary: Get process information by its ID for a specific scaled-out instance in a web site.
description: Description for Get process information by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteProcessSlot
tags:
- WebApps
summary: Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
description: Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'204':
description: Resource does not exist.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump
: get:
operationId: WebApps_GetProcessDumpSlot
tags:
- WebApps
summary: Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
description: Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.
produces:
- '*/*'
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules
: get:
operationId: WebApps_ListProcessModulesSlot
tags:
- WebApps
summary: List module information for a process by its ID for a specific scaled-out instance in a web site.
description: Description for List module information for a process by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessModuleInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}
: get:
operationId: WebApps_GetProcessModuleSlot
tags:
- WebApps
summary: Get process information by its ID for a specific scaled-out instance in a web site.
description: Description for Get process information by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
- name: baseAddress
in: path
description: Module base address.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessModuleInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads
: get:
operationId: WebApps_ListProcessThreadsSlot
tags:
- WebApps
summary: List the threads in a process by its ID for a specific scaled-out instance in a web site.
description: Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: processId
in: path
description: PID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/ProcessThreadInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates
: get:
operationId: WebApps_ListPublicCertificatesSlot
tags:
- WebApps
summary: Get public certificates for an app or a deployment slot.
description: Description for Get public certificates for an app or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PublicCertificateCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}
: get:
operationId: WebApps_GetPublicCertificateSlot
tags:
- WebApps
summary: Get the named public certificate for an app (or deployment slot, if specified).
description: Description for Get the named public certificate for an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.
required: true
type: string
- name: publicCertificateName
in: path
description: Public certificate name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/PublicCertificate'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdatePublicCertificateSlot
tags:
- WebApps
summary: Creates a hostname binding for an app.
description: Description for Creates a hostname binding for an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.
required: true
type: string
- name: publicCertificateName
in: path
description: Public certificate name.
required: true
type: string
- name: publicCertificate
in: body
description: Public certificate details. This is the JSON representation of a PublicCertificate object.
required: true
schema:
$ref: '#/definitions/PublicCertificate'
responses:
'200':
description: Resource 'PublicCertificate' update operation succeeded
schema:
$ref: '#/definitions/PublicCertificate'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeletePublicCertificateSlot
tags:
- WebApps
summary: Deletes a hostname binding for an app.
description: Description for Deletes a hostname binding for an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.
required: true
type: string
- name: publicCertificateName
in: path
description: Public certificate name.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml
: post:
operationId: WebApps_ListPublishingProfileXmlWithSecretsSlot
tags:
- WebApps
summary: Gets the publishing profile for an app (or deployment slot, if specified).
description: Description for Gets the publishing profile for an app (or deployment slot, if specified).
produces:
- application/xml
- application/json
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: publishingProfileOptions
in: body
description: 'Specifies publishingProfileOptions for publishing profile. For example, use {" format": "FileZilla3"} to get a FileZilla publishing profile.'
required: true
schema:
$ref: '#/definitions/CsmPublishingProfileOptions'
responses:
'200':
description: Azure operation completed successfully.
schema:
type: file
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig
: post:
operationId: WebApps_ResetSlotConfigurationSlot
tags:
- WebApps
summary: Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
description: Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart
: post:
operationId: WebApps_RestartSlot
tags:
- WebApps
summary: Restarts an app (or deployment slot, if specified).
description: Description for Restarts an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: softRestart
in: query
description: Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.
required: false
type: boolean
- name: synchronous
in: query
description: Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).
required: false
type: boolean
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob
: post:
operationId: WebApps_RestoreFromBackupBlobSlot
tags:
- WebApps
summary: Restores an app from a backup blob in Azure Storage.
description: Description for Restores an app from a backup blob in Azure Storage.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: request
in: body
description: Information on restore request .
required: true
schema:
$ref: '#/definitions/RestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp
: post:
operationId: WebApps_RestoreFromDeletedAppSlot
tags:
- WebApps
summary: Restores a deleted web app to this web app.
description: Description for Restores a deleted web app to this web app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: restoreRequest
in: body
description: Deleted web app restore information.
required: true
schema:
$ref: '#/definitions/DeletedAppRestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot
: post:
operationId: WebApps_RestoreSnapshotSlot
tags:
- WebApps
summary: Restores a web app from a snapshot.
description: Description for Restores a web app from a snapshot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: restoreRequest
in: body
description: Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.
required: true
schema:
$ref: '#/definitions/SnapshotRestoreRequest'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers
: get:
operationId: WebApps_ListSiteContainersSlot
tags:
- WebApps
summary: Lists all the site containers of a site, or a deployment slot.
description: Lists all the site containers of a site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteContainerCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}
: get:
operationId: WebApps_GetSiteContainerSlot
tags:
- WebApps
summary: Gets a site container of a site, or a deployment slot.
description: Gets a site container of a site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.
required: true
type: string
- name: containerName
in: path
description: Site Container Name
required: true
type: string
pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteContainer'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateSiteContainerSlot
tags:
- WebApps
summary: Creates or Updates a site container for a site, or a deployment slot.
description: Creates or Updates a site container for a site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.
required: true
type: string
- name: containerName
in: path
description: Site Container Name
required: true
type: string
pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)
- name: request
in: body
description: Container Entity
required: true
schema:
$ref: '#/definitions/SiteContainer'
responses:
'200':
description: Resource 'SiteContainer' update operation succeeded
schema:
$ref: '#/definitions/SiteContainer'
'201':
description: Resource 'SiteContainer' create operation succeeded
schema:
$ref: '#/definitions/SiteContainer'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteSiteContainerSlot
tags:
- WebApps
summary: Deletes a site container for a site, or a deployment slot.
description: Deletes a site container for a site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.
required: true
type: string
- name: containerName
in: path
description: Site Container Name
required: true
type: string
pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions
: get:
operationId: WebApps_ListSiteExtensionsSlot
tags:
- WebApps
summary: Get list of siteextensions for a web site, or a deployment slot.
description: Description for Get list of siteextensions for a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteExtensionInfoCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}
: get:
operationId: WebApps_GetSiteExtensionSlot
tags:
- WebApps
summary: Get site extension information by its ID for a web site, or a deployment slot.
description: Description for Get site extension information by its ID for a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
- name: siteExtensionId
in: path
description: Site extension name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteExtensionInfo'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_InstallSiteExtensionSlot
tags:
- WebApps
summary: Install site extension on a web site, or a deployment slot.
description: Description for Install site extension on a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
- name: siteExtensionId
in: path
description: Site extension name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteExtensionInfo'
'201':
description: Resource 'SiteExtensionInfo' create operation succeeded
schema:
$ref: '#/definitions/SiteExtensionInfo'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'429':
description: Client error
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/SiteExtensionInfo'
x-ms-long-running-operation: true
delete:
operationId: WebApps_DeleteSiteExtensionSlot
tags:
- WebApps
summary: Remove a site extension from a web site, or a deployment slot.
description: Description for Remove a site extension from a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
- name: siteExtensionId
in: path
description: Site extension name.
required: true
type: string
responses:
'204':
description: Resource does not exist.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs
: post:
operationId: WebApps_ListSlotDifferencesSlot
tags:
- WebApps
summary: Get the difference in configuration settings between two web app slots.
description: Description for Get the difference in configuration settings between two web app slots.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: slotSwapEntity
in: body
description: JSON object that contains the target slot name. See example.
required: true
schema:
$ref: '#/definitions/CsmSlotEntity'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SlotDifferenceCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap
: post:
operationId: WebApps_SwapSlotSlot
tags:
- WebApps
summary: Swaps two deployment slots of an app.
description: Description for Swaps two deployment slots of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: slotSwapEntity
in: body
description: JSON object that contains the target slot name. See example.
required: true
schema:
$ref: '#/definitions/CsmSlotEntity'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots
: get:
operationId: WebApps_ListSnapshotsSlot
tags:
- WebApps
summary: Returns all Snapshots to the user.
description: Description for Returns all Snapshots to the user.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SnapshotCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr
: get:
operationId: WebApps_ListSnapshotsFromDRSecondarySlot
tags:
- WebApps
summary: Returns all Snapshots to the user from DRSecondary endpoint.
description: Description for Returns all Snapshots to the user from DRSecondary endpoint.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SnapshotCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web
: get:
operationId: WebApps_GetSourceControlSlot
tags:
- WebApps
summary: Gets the source control configuration of an app.
description: Description for Gets the source control configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteSourceControl'
'201':
description: Resource 'SiteSourceControl' create operation succeeded
schema:
$ref: '#/definitions/SiteSourceControl'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/SiteSourceControl'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateSourceControlSlot
tags:
- WebApps
summary: Updates the source control configuration of an app.
description: Description for Updates the source control configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.
required: true
type: string
- name: siteSourceControl
in: body
description: JSON representation of a SiteSourceControl object. See example.
required: true
schema:
$ref: '#/definitions/SiteSourceControl'
responses:
'200':
description: Resource 'SiteSourceControl' update operation succeeded
schema:
$ref: '#/definitions/SiteSourceControl'
'201':
description: Resource 'SiteSourceControl' create operation succeeded
schema:
$ref: '#/definitions/SiteSourceControl'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/SiteSourceControl'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/SiteSourceControl'
x-ms-long-running-operation: true
patch:
operationId: WebApps_UpdateSourceControlSlot
tags:
- WebApps
summary: Updates the source control configuration of an app.
description: Description for Updates the source control configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.
required: true
type: string
- name: siteSourceControl
in: body
description: JSON representation of a SiteSourceControl object. See example.
required: true
schema:
$ref: '#/definitions/SiteSourceControl'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteSourceControl'
'201':
description: Resource 'SiteSourceControl' create operation succeeded
schema:
$ref: '#/definitions/SiteSourceControl'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/SiteSourceControl'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteSourceControlSlot
tags:
- WebApps
summary: Deletes the source control configuration of an app.
description: Description for Deletes the source control configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.
required: true
type: string
- name: additionalFlags
in: query
required: false
type: string
responses:
'200':
description: Resource deleted successfully.
'202':
description: The request has been accepted for processing, but processing has not yet completed.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start:
post:
operationId: WebApps_StartSlot
tags:
- WebApps
summary: Starts an app (or deployment slot, if specified).
description: Description for Starts an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/startNetworkTrace
: post:
operationId: WebApps_StartNetworkTraceSlot
tags:
- WebApps
summary: Start capturing network packets for the site.
description: Description for Start capturing network packets for the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: durationInSeconds
in: query
description: The duration to keep capturing in seconds.
required: false
type: integer
format: int32
- name: maxFrameLength
in: query
description: The maximum frame length in bytes (Optional).
required: false
type: integer
format: int32
- name: sasUrl
in: query
description: The Blob URL to store capture file.
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
'202':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Start a new network trace operation for a site:
$ref: ./examples/StartWebSiteNetworkTraceOperation_StartNetworkTraceSlot.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop:
post:
operationId: WebApps_StopSlot
tags:
- WebApps
summary: Stops an app (or deployment slot, if specified).
description: Description for Stops an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stopNetworkTrace
: post:
operationId: WebApps_StopNetworkTraceSlot
tags:
- WebApps
summary: Stop ongoing capturing network packets for the site.
description: Description for Stop ongoing capturing network packets for the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Stop a currently running network trace operation for a site:
$ref: ./examples/StopWebSiteNetworkTrace_StopNetworkTraceSlot.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync:
post:
operationId: WebApps_SyncRepositorySlot
tags:
- WebApps
summary: Sync web app repository.
description: Description for Sync web app repository.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers
: post:
operationId: WebApps_SyncFunctionTriggersSlot
tags:
- WebApps
summary: Syncs function trigger metadata to the management database
description: Description for Syncs function trigger metadata to the management database
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs
: get:
operationId: WebApps_ListTriggeredWebJobsSlot
tags:
- WebApps
summary: List triggered web jobs for an app, or a deployment slot.
description: Description for List triggered web jobs for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/TriggeredWebJobCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}
: get:
operationId: WebApps_GetTriggeredWebJobSlot
tags:
- WebApps
summary: Gets a triggered web job by its ID for an app, or a deployment slot.
description: Description for Gets a triggered web job by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/TriggeredWebJob'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteTriggeredWebJobSlot
tags:
- WebApps
summary: Delete a triggered web job by its ID for an app, or a deployment slot.
description: Description for Delete a triggered web job by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history
: get:
operationId: WebApps_ListTriggeredWebJobHistorySlot
tags:
- WebApps
summary: List a triggered web job's history for an app, or a deployment slot.
description: Description for List a triggered web job's history for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/TriggeredJobHistoryCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}
: get:
operationId: WebApps_GetTriggeredWebJobHistorySlot
tags:
- WebApps
summary: Gets a triggered web job's history by its ID for an app, , or a deployment slot.
description: Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
- name: id
in: path
description: History ID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/TriggeredJobHistory'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run
: post:
operationId: WebApps_RunTriggeredWebJobSlot
tags:
- WebApps
summary: Run a triggered web job for an app, or a deployment slot.
description: Description for Run a triggered web job for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API uses the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages
: get:
operationId: WebApps_ListUsagesSlot
tags:
- WebApps
summary: Gets the quota usage information of an app (or deployment slot, if specified).
description: Description for Gets the quota usage information of an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: $filter
in: query
description: 'Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq ''Metric1'' or name.value eq ''Metric2'') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration''[Hour|Minute|Day]''.'
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmUsageQuotaCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections
: get:
operationId: WebApps_ListVnetConnectionsSlot
tags:
- WebApps
summary: Gets the virtual networks the app (or deployment slot) is connected to.
description: Description for Gets the virtual networks the app (or deployment slot) is connected to.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/VnetInfoResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}
: get:
operationId: WebApps_GetVnetConnectionSlot
tags:
- WebApps
summary: Gets a virtual network the app (or deployment slot) is connected to by name.
description: Description for Gets a virtual network the app (or deployment slot) is connected to by name.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.
required: true
type: string
- name: vnetName
in: path
description: Name of the virtual network.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/VnetInfoResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateVnetConnectionSlot
tags:
- WebApps
summary: Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
description: Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.
required: true
type: string
- name: vnetName
in: path
description: Name of the virtual network.
required: true
type: string
- name: connectionEnvelope
in: body
description: Properties of the Virtual Network connection. See example.
required: true
schema:
$ref: '#/definitions/VnetInfoResource'
responses:
'200':
description: Resource 'VnetInfoResource' update operation succeeded
schema:
$ref: '#/definitions/VnetInfoResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateVnetConnectionSlot
tags:
- WebApps
summary: Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
description: Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.
required: true
type: string
- name: vnetName
in: path
description: Name of the virtual network.
required: true
type: string
- name: connectionEnvelope
in: body
description: Properties of the Virtual Network connection. See example.
required: true
schema:
$ref: '#/definitions/VnetInfoResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/VnetInfoResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteVnetConnectionSlot
tags:
- WebApps
summary: Deletes a connection from an app (or deployment slot to a named virtual network.
description: Description for Deletes a connection from an app (or deployment slot to a named virtual network.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.
required: true
type: string
- name: vnetName
in: path
description: Name of the virtual network.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
: get:
operationId: WebApps_GetVnetConnectionGatewaySlot
tags:
- WebApps
summary: Gets an app's Virtual Network gateway.
description: Description for Gets an app's Virtual Network gateway.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.
required: true
type: string
- name: vnetName
in: path
description: Name of the Virtual Network.
required: true
type: string
- name: gatewayName
in: path
description: Name of the gateway. Currently, the only supported string is "primary".
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/VnetGateway'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateVnetConnectionGatewaySlot
tags:
- WebApps
summary: Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
description: Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.
required: true
type: string
- name: vnetName
in: path
description: Name of the Virtual Network.
required: true
type: string
- name: gatewayName
in: path
description: Name of the gateway. Currently, the only supported string is "primary".
required: true
type: string
- name: connectionEnvelope
in: body
description: The properties to update this gateway with.
required: true
schema:
$ref: '#/definitions/VnetGateway'
responses:
'200':
description: Resource 'VnetGateway' update operation succeeded
schema:
$ref: '#/definitions/VnetGateway'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateVnetConnectionGatewaySlot
tags:
- WebApps
summary: Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
description: Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.
required: true
type: string
- name: vnetName
in: path
description: Name of the Virtual Network.
required: true
type: string
- name: gatewayName
in: path
description: Name of the gateway. Currently, the only supported string is "primary".
required: true
type: string
- name: connectionEnvelope
in: body
description: The properties to update this gateway with.
required: true
schema:
$ref: '#/definitions/VnetGateway'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/VnetGateway'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs
: get:
operationId: WebApps_ListWebJobsSlot
tags:
- WebApps
summary: List webjobs for an app, or a deployment slot.
description: Description for List webjobs for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebJobCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}
: get:
operationId: WebApps_GetWebJobSlot
tags:
- WebApps
summary: Get webjob information for an app, or a deployment slot.
description: Description for Get webjob information for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.
required: true
type: string
- name: webJobName
in: path
description: Name of the web job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebJob'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows
: get:
operationId: WebApps_ListInstanceWorkflowsSlot
tags:
- WebApps
summary: List the workflows for a web site, or a deployment slot.
description: List the workflows for a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WorkflowEnvelopeCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List the workflows Slot:
$ref: ./examples/ListWorkflows_Slot.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows/{workflowName}
: get:
operationId: WebApps_GetInstanceWorkflowSlot
tags:
- WebApps
summary: Get workflow information by its ID for web site, or a deployment slot.
description: Get workflow information by its ID for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot.
required: true
type: string
- name: workflowName
in: path
description: Workflow name.
required: true
type: string
minLength: 3
maxLength: 63
pattern: ^[a-z][a-z0-9]*$
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WorkflowEnvelope'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
GET a workflow Slot:
$ref: ./examples/GetWorkflow_Slot.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs:
post:
operationId: WebApps_ListSlotDifferencesFromProduction
tags:
- WebApps
summary: Get the difference in configuration settings between two web app slots.
description: Description for Get the difference in configuration settings between two web app slots.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slotSwapEntity
in: body
description: JSON object that contains the target slot name. See example.
required: true
schema:
$ref: '#/definitions/CsmSlotEntity'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SlotDifferenceCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap:
post:
operationId: WebApps_SwapSlotWithProduction
tags:
- WebApps
summary: Swaps two deployment slots of an app.
description: Description for Swaps two deployment slots of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slotSwapEntity
in: body
description: JSON object that contains the target slot name. See example.
required: true
schema:
$ref: '#/definitions/CsmSlotEntity'
responses:
'200':
description: Azure operation completed successfully.
'202':
description: Resource operation accepted.
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots:
get:
operationId: WebApps_ListSnapshots
tags:
- WebApps
summary: Returns all Snapshots to the user.
description: Description for Returns all Snapshots to the user.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SnapshotCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr:
get:
operationId: WebApps_ListSnapshotsFromDRSecondary
tags:
- WebApps
summary: Returns all Snapshots to the user from DRSecondary endpoint.
description: Description for Returns all Snapshots to the user from DRSecondary endpoint.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SnapshotCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web:
get:
operationId: WebApps_GetSourceControl
tags:
- WebApps
summary: Gets the source control configuration of an app.
description: Description for Gets the source control configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteSourceControl'
'201':
description: Resource 'SiteSourceControl' create operation succeeded
schema:
$ref: '#/definitions/SiteSourceControl'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/SiteSourceControl'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateSourceControl
tags:
- WebApps
summary: Updates the source control configuration of an app.
description: Description for Updates the source control configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: siteSourceControl
in: body
description: JSON representation of a SiteSourceControl object. See example.
required: true
schema:
$ref: '#/definitions/SiteSourceControl'
responses:
'200':
description: Resource 'SiteSourceControl' update operation succeeded
schema:
$ref: '#/definitions/SiteSourceControl'
'201':
description: Resource 'SiteSourceControl' create operation succeeded
schema:
$ref: '#/definitions/SiteSourceControl'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/SiteSourceControl'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/SiteSourceControl'
x-ms-long-running-operation: true
patch:
operationId: WebApps_UpdateSourceControl
tags:
- WebApps
summary: Updates the source control configuration of an app.
description: Description for Updates the source control configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: siteSourceControl
in: body
description: JSON representation of a SiteSourceControl object. See example.
required: true
schema:
$ref: '#/definitions/SiteSourceControl'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/SiteSourceControl'
'201':
description: Resource 'SiteSourceControl' create operation succeeded
schema:
$ref: '#/definitions/SiteSourceControl'
'202':
description: The request has been accepted for processing, but processing has not yet completed.
schema:
$ref: '#/definitions/SiteSourceControl'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteSourceControl
tags:
- WebApps
summary: Deletes the source control configuration of an app.
description: Description for Deletes the source control configuration of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: additionalFlags
in: query
required: false
type: string
responses:
'200':
description: Resource deleted successfully.
'202':
description: The request has been accepted for processing, but processing has not yet completed.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start:
post:
operationId: WebApps_Start
tags:
- WebApps
summary: Starts an app (or deployment slot, if specified).
description: Description for Starts an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/startNetworkTrace:
post:
operationId: WebApps_StartNetworkTrace
tags:
- WebApps
summary: Start capturing network packets for the site.
description: Description for Start capturing network packets for the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: durationInSeconds
in: query
description: The duration to keep capturing in seconds.
required: false
type: integer
format: int32
- name: maxFrameLength
in: query
description: The maximum frame length in bytes (Optional).
required: false
type: integer
format: int32
- name: sasUrl
in: query
description: The Blob URL to store capture file.
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
'202':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
headers:
Location:
type: string
description: The Location header contains the URL where the status of the long running operation can be checked.
Retry-After:
type: integer
format: int32
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Start a new network trace operation for a site:
$ref: ./examples/StartWebSiteNetworkTraceOperation_StartNetworkTrace.json
x-ms-long-running-operation-options:
final-state-via: location
x-ms-long-running-operation: true
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop:
post:
operationId: WebApps_Stop
tags:
- WebApps
summary: Stops an app (or deployment slot, if specified).
description: Description for Stops an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stopNetworkTrace:
post:
operationId: WebApps_StopNetworkTrace
tags:
- WebApps
summary: Stop ongoing capturing network packets for the site.
description: Description for Stop ongoing capturing network packets for the site.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Stop a currently running network trace operation for a site:
$ref: ./examples/StopWebSiteNetworkTrace_StopNetworkTrace.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync:
post:
operationId: WebApps_SyncRepository
tags:
- WebApps
summary: Sync web app repository.
description: Description for Sync web app repository.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers
: post:
operationId: WebApps_SyncFunctionTriggers
tags:
- WebApps
summary: Syncs function trigger metadata to the management database
description: Description for Syncs function trigger metadata to the management database
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs:
get:
operationId: WebApps_ListTriggeredWebJobs
tags:
- WebApps
summary: List triggered web jobs for an app, or a deployment slot.
description: Description for List triggered web jobs for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/TriggeredWebJobCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}
: get:
operationId: WebApps_GetTriggeredWebJob
tags:
- WebApps
summary: Gets a triggered web job by its ID for an app, or a deployment slot.
description: Description for Gets a triggered web job by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/TriggeredWebJob'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteTriggeredWebJob
tags:
- WebApps
summary: Delete a triggered web job by its ID for an app, or a deployment slot.
description: Description for Delete a triggered web job by its ID for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'204':
description: Resource does not exist.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history
: get:
operationId: WebApps_ListTriggeredWebJobHistory
tags:
- WebApps
summary: List a triggered web job's history for an app, or a deployment slot.
description: Description for List a triggered web job's history for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/TriggeredJobHistoryCollection'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}
: get:
operationId: WebApps_GetTriggeredWebJobHistory
tags:
- WebApps
summary: Gets a triggered web job's history by its ID for an app, , or a deployment slot.
description: Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
- name: id
in: path
description: History ID.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/TriggeredJobHistory'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run
: post:
operationId: WebApps_RunTriggeredWebJob
tags:
- WebApps
summary: Run a triggered web job for an app, or a deployment slot.
description: Description for Run a triggered web job for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of Web Job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/updatemachinekey:
post:
operationId: WebApps_UpdateMachineKey
tags:
- WebApps
summary: Updates the machine key of an app.
description: Updates the machine key of an app.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema: {}
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Updates the machine key for a site:
$ref: ./examples/UpdateMachineKey.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages:
get:
operationId: WebApps_ListUsages
tags:
- WebApps
summary: Gets the quota usage information of an app (or deployment slot, if specified).
description: Description for Gets the quota usage information of an app (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: $filter
in: query
description: 'Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq ''Metric1'' or name.value eq ''Metric2'') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration''[Hour|Minute|Day]''.'
required: false
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/CsmUsageQuotaCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections
: get:
operationId: WebApps_ListVnetConnections
tags:
- WebApps
summary: Gets the virtual networks the app (or deployment slot) is connected to.
description: Description for Gets the virtual networks the app (or deployment slot) is connected to.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/VnetInfoResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}
: get:
operationId: WebApps_GetVnetConnection
tags:
- WebApps
summary: Gets a virtual network the app (or deployment slot) is connected to by name.
description: Description for Gets a virtual network the app (or deployment slot) is connected to by name.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: vnetName
in: path
description: Name of the virtual network.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/VnetInfoResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateVnetConnection
tags:
- WebApps
summary: Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
description: Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: vnetName
in: path
description: Name of the virtual network.
required: true
type: string
- name: connectionEnvelope
in: body
description: Properties of the Virtual Network connection. See example.
required: true
schema:
$ref: '#/definitions/VnetInfoResource'
responses:
'200':
description: Resource 'VnetInfoResource' update operation succeeded
schema:
$ref: '#/definitions/VnetInfoResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateVnetConnection
tags:
- WebApps
summary: Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
description: Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: vnetName
in: path
description: Name of the virtual network.
required: true
type: string
- name: connectionEnvelope
in: body
description: Properties of the Virtual Network connection. See example.
required: true
schema:
$ref: '#/definitions/VnetInfoResource'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/VnetInfoResource'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteVnetConnection
tags:
- WebApps
summary: Deletes a connection from an app (or deployment slot to a named virtual network.
description: Description for Deletes a connection from an app (or deployment slot to a named virtual network.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: vnetName
in: path
description: Name of the virtual network.
required: true
type: string
responses:
'200':
description: Resource deleted successfully.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}
: get:
operationId: WebApps_GetVnetConnectionGateway
tags:
- WebApps
summary: Gets an app's Virtual Network gateway.
description: Description for Gets an app's Virtual Network gateway.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: vnetName
in: path
description: Name of the Virtual Network.
required: true
type: string
- name: gatewayName
in: path
description: Name of the gateway. Currently, the only supported string is "primary".
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/VnetGateway'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
put:
operationId: WebApps_CreateOrUpdateVnetConnectionGateway
tags:
- WebApps
summary: Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
description: Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: vnetName
in: path
description: Name of the Virtual Network.
required: true
type: string
- name: gatewayName
in: path
description: Name of the gateway. Currently, the only supported string is "primary".
required: true
type: string
- name: connectionEnvelope
in: body
description: The properties to update this gateway with.
required: true
schema:
$ref: '#/definitions/VnetGateway'
responses:
'200':
description: Resource 'VnetGateway' update operation succeeded
schema:
$ref: '#/definitions/VnetGateway'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
patch:
operationId: WebApps_UpdateVnetConnectionGateway
tags:
- WebApps
summary: Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
description: Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: vnetName
in: path
description: Name of the Virtual Network.
required: true
type: string
- name: gatewayName
in: path
description: Name of the gateway. Currently, the only supported string is "primary".
required: true
type: string
- name: connectionEnvelope
in: body
description: The properties to update this gateway with.
required: true
schema:
$ref: '#/definitions/VnetGateway'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/VnetGateway'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs:
get:
operationId: WebApps_ListWebJobs
tags:
- WebApps
summary: List webjobs for an app, or a deployment slot.
description: Description for List webjobs for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebJobCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}
: get:
operationId: WebApps_GetWebJob
tags:
- WebApps
summary: Get webjob information for an app, or a deployment slot.
description: Description for Get webjob information for an app, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: webJobName
in: path
description: Name of the web job.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WebJob'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows:
get:
operationId: WebApps_ListWorkflows
tags:
- WebApps
summary: List the workflows for a web site, or a deployment slot.
description: List the workflows for a web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WorkflowEnvelopeCollection'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
List the workflows:
$ref: ./examples/ListWorkflows.json
x-ms-pageable:
nextLinkName: nextLink
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows/{workflowName}
: get:
operationId: WebApps_GetWorkflow
tags:
- WebApps
summary: Get workflow information by its ID for web site, or a deployment slot.
description: Get workflow information by its ID for web site, or a deployment slot.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Site name.
required: true
type: string
- name: workflowName
in: path
description: Workflow name.
required: true
type: string
minLength: 3
maxLength: 63
pattern: ^[a-z][a-z0-9]*$
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/WorkflowEnvelope'
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
GET a workflow:
$ref: ./examples/GetWorkflow.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/functions/{functionName}/keys/{keyName}
: put:
operationId: WebApps_CreateOrUpdateFunctionSecret
tags:
- WebApps
summary: Add or update a function secret.
description: Description for Add or update a function secret.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
required: true
type: string
- name: functionName
in: path
required: true
type: string
- name: keyName
in: path
required: true
type: string
- name: key
in: body
description: The key to create or update
required: true
schema:
$ref: '#/definitions/KeyInfo'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/KeyInfo'
'201':
description: Resource 'KeyInfo' create operation succeeded
schema:
$ref: '#/definitions/KeyInfo'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteFunctionSecret
tags:
- WebApps
summary: Delete a function secret.
description: Description for Delete a function secret.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
required: true
type: string
- name: functionName
in: path
required: true
type: string
- name: keyName
in: path
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}
: put:
operationId: WebApps_CreateOrUpdateHostSecret
tags:
- WebApps
summary: Add or update a host level secret.
description: Description for Add or update a host level secret.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: keyType
in: path
description: The type of host key.
required: true
type: string
- name: keyName
in: path
description: The name of the key.
required: true
type: string
- name: key
in: body
description: The key to create or update
required: true
schema:
$ref: '#/definitions/KeyInfo'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/KeyInfo'
'201':
description: Resource 'KeyInfo' create operation succeeded
schema:
$ref: '#/definitions/KeyInfo'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteHostSecret
tags:
- WebApps
summary: Delete a host level secret.
description: Description for Delete a host level secret.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: keyType
in: path
description: The type of host key.
required: true
type: string
- name: keyName
in: path
description: The name of the key.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/networkTrace/{operationId}
: get:
operationId: WebApps_GetNetworkTraces
tags:
- WebApps
summary: Gets a named operation for a network trace capturing (or deployment slot, if specified).
description: Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: operationId
in: path
description: GUID of the operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get NetworkTraces for a site:
$ref: ./examples/GetWebSiteNetworkTraces.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}
: get:
operationId: WebApps_GetNetworkTraceOperation
tags:
- WebApps
summary: Gets a named operation for a network trace capturing (or deployment slot, if specified).
description: Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: operationId
in: path
description: GUID of the operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
'202':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get the current status of a network trace operation for a site:
$ref: ./examples/GetWebSiteNetworkTraceOperation.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/networkTraces/{operationId}
: get:
operationId: WebApps_GetNetworkTracesV2
tags:
- WebApps
summary: Gets a named operation for a network trace capturing (or deployment slot, if specified).
description: Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: operationId
in: path
description: GUID of the operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get NetworkTraces for a site:
$ref: ./examples/GetWebSiteNetworkTraces_SlotV2.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}
: get:
operationId: WebApps_GetNetworkTraceOperationV2
tags:
- WebApps
summary: Gets a named operation for a network trace capturing (or deployment slot, if specified).
description: Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: operationId
in: path
description: GUID of the operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
'202':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get the current status of a network trace operation for a site:
$ref: ./examples/GetWebSiteNetworkTraceOperation_V2.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}
: put:
operationId: WebApps_CreateOrUpdateHostSecretSlot
tags:
- WebApps
summary: Add or update a host level secret.
description: Description for Add or update a host level secret.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: keyType
in: path
description: The type of host key.
required: true
type: string
- name: keyName
in: path
description: The name of the key.
required: true
type: string
- name: key
in: body
description: The key to create or update
required: true
schema:
$ref: '#/definitions/KeyInfo'
responses:
'200':
description: Azure operation completed successfully.
schema:
$ref: '#/definitions/KeyInfo'
'201':
description: Resource 'KeyInfo' create operation succeeded
schema:
$ref: '#/definitions/KeyInfo'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
delete:
operationId: WebApps_DeleteHostSecretSlot
tags:
- WebApps
summary: Delete a host level secret.
description: Description for Delete a host level secret.
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: keyType
in: path
description: The type of host key.
required: true
type: string
- name: keyName
in: path
description: The name of the key.
required: true
type: string
responses:
'204':
description: There is no content to send for this request, but the headers may be useful.
'404':
description: The server cannot find the requested resource.
x-ms-error-response: true
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}
: get:
operationId: WebApps_GetNetworkTracesSlot
tags:
- WebApps
summary: Gets a named operation for a network trace capturing (or deployment slot, if specified).
description: Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: operationId
in: path
description: GUID of the operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get NetworkTraces for a site:
$ref: ./examples/GetWebSiteNetworkTraces_Slot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId}
: get:
operationId: WebApps_GetNetworkTraceOperationSlot
tags:
- WebApps
summary: Gets a named operation for a network trace capturing (or deployment slot, if specified).
description: Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: operationId
in: path
description: GUID of the operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
'202':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get the current status of a network trace operation for a site:
$ref: ./examples/GetWebSiteNetworkTraceOperation_Slot.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}
: get:
operationId: WebApps_GetNetworkTracesSlotV2
tags:
- WebApps
summary: Gets a named operation for a network trace capturing (or deployment slot, if specified).
description: Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: operationId
in: path
description: GUID of the operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get NetworkTraces for a site:
$ref: ./examples/GetWebSiteNetworkTraces_GetNetworkTracesSlotV2.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}
: get:
operationId: WebApps_GetNetworkTraceOperationSlotV2
tags:
- WebApps
summary: Gets a named operation for a network trace capturing (or deployment slot, if specified).
description: Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: name
in: path
description: Name of the app.
required: true
type: string
- name: slot
in: path
description: Name of the deployment slot. By default, this API returns the production slot.
required: true
type: string
- name: operationId
in: path
description: GUID of the operation.
required: true
type: string
responses:
'200':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
'202':
description: Azure operation completed successfully.
schema:
type: array
items:
$ref: '#/definitions/NetworkTrace'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/DefaultErrorResponse'
x-ms-examples:
Get the current status of a network trace operation for a site:
$ref: ./examples/GetWebSiteNetworkTraceOperation_SlotV2.json
definitions:
ProcessInfoProperties:
type: object
description: ProcessInfo resource specific properties
properties:
identifier:
type: integer
format: int32
description: ARM Identifier for deployment.
readOnly: true
deployment_name:
type: string
description: Deployment name.
x-ms-client-name: deploymentName
href:
type: string
description: HRef URI.
minidump:
type: string
description: Minidump URI.
is_profile_running:
type: boolean
description: Is profile running?
x-ms-client-name: isProfileRunning
is_iis_profile_running:
type: boolean
description: Is the IIS Profile running?
x-ms-client-name: isIisProfileRunning
iis_profile_timeout_in_seconds:
type: number
format: double
description: IIS Profile timeout (seconds).
x-ms-client-name: iisProfileTimeoutInSeconds
parent:
type: string
description: Parent process.
children:
type: array
description: Child process list.
items:
type: string
threads:
type: array
description: Thread list.
items:
$ref: '#/definitions/ProcessThreadInfo'
open_file_handles:
type: array
description: List of open files.
items:
type: string
x-ms-client-name: openFileHandles
modules:
type: array
description: List of modules.
items:
$ref: '#/definitions/ProcessModuleInfo'
file_name:
type: string
description: File name of this process.
x-ms-client-name: fileName
command_line:
type: string
description: Command line.
x-ms-client-name: commandLine
user_name:
type: string
description: User name.
x-ms-client-name: userName
handle_count:
type: integer
format: int32
description: Handle count.
x-ms-client-name: handleCount
module_count:
type: integer
format: int32
description: Module count.
x-ms-client-name: moduleCount
thread_count:
type: integer
format: int32
description: Thread count.
x-ms-client-name: threadCount
start_time:
type: string
format: date-time
description: Start time.
x-ms-client-name: startTime
total_cpu_time:
type: string
description: Total CPU time.
x-ms-client-name: totalCpuTime
user_cpu_time:
type: string
description: User CPU time.
x-ms-client-name: userCpuTime
privileged_cpu_time:
type: string
description: Privileged CPU time.
x-ms-client-name: privilegedCpuTime
working_set:
type: integer
format: int64
description: Working set.
x-ms-client-name: workingSet
peak_working_set:
type: integer
format: int64
description: Peak working set.
x-ms-client-name: peakWorkingSet
private_memory:
type: integer
format: int64
description: Private memory size.
x-ms-client-name: privateMemory
virtual_memory:
type: integer
format: int64
description: Virtual memory size.
x-ms-client-name: virtualMemory
peak_virtual_memory:
type: integer
format: int64
description: Peak virtual memory usage.
x-ms-client-name: peakVirtualMemory
paged_system_memory:
type: integer
format: int64
description: Paged system memory.
x-ms-client-name: pagedSystemMemory
non_paged_system_memory:
type: integer
format: int64
description: Non-paged system memory.
x-ms-client-name: nonPagedSystemMemory
paged_memory:
type: integer
format: int64
description: Paged memory.
x-ms-client-name: pagedMemory
peak_paged_memory:
type: integer
format: int64
description: Peak paged memory.
x-ms-client-name: peakPagedMemory
time_stamp:
type: string
format: date-time
description: Time stamp.
x-ms-client-name: timeStamp
environment_variables:
type: object
description: List of environment variables.
additionalProperties:
type: string
x-ms-client-name: environmentVariables
is_scm_site:
type: boolean
description: Is this the SCM site?
x-ms-client-name: isScmSite
is_webjob:
type: boolean
description: Is this a Web Job?
x-ms-client-name: isWebjob
description:
type: string
description: Description of process.
RedundancyMode:
type: string
description: Site redundancy mode
enum:
- None
- Manual
- Failover
- ActiveActive
- GeoRedundant
x-ms-enum:
name: RedundancyMode
modelAsString: false
Identifier:
type: object
description: A domain specific resource identifier.
properties:
properties:
$ref: '#/definitions/IdentifierProperties'
description: Identifier resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
VnetRouteProperties:
type: object
description: VnetRoute resource specific properties
properties:
startAddress:
type: string
description: The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.
endAddress:
type: string
description: The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.
routeType:
$ref: '#/definitions/RouteType'
description: 'The type of route this is:
DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918
INHERITED - Routes inherited from the real Virtual Network routes
STATIC - Static route set on the app only
These values will be used for syncing an app''s routes with those from a Virtual Network.'
ResourceConfig:
type: object
description: Function app resource requirements.
properties:
cpu:
type: number
format: double
description: Required CPU in cores, e.g. 0.5
memory:
type: string
description: Required memory, e.g. "1Gi"
MSDeployProvisioningState:
type: string
description: Provisioning state
enum:
- accepted
- running
- succeeded
- failed
- canceled
x-ms-enum:
name: MSDeployProvisioningState
modelAsString: false
IdentifierProperties:
type: object
description: Identifier resource specific properties
properties:
id:
type: string
description: String representation of the identity.
x-ms-client-name: value
WorkflowEnvelope:
type: object
description: Workflow properties definition.
properties:
properties:
$ref: '#/definitions/WorkflowEnvelopeProperties'
description: Additional workflow properties.
kind:
type: string
description: The resource kind.
location:
type: string
description: The resource location.
x-ms-mutability:
- read
- create
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
AutoHealActionType:
type: string
description: Predefined action to be taken.
enum:
- Recycle
- LogEvent
- CustomAction
x-ms-enum:
name: AutoHealActionType
modelAsString: false
SiteContainerCollection:
type: object
description: Collection of site containers
properties:
value:
type: array
description: The SiteContainer items on this page
items:
$ref: '#/definitions/SiteContainer'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
MigrateMySqlRequest:
type: object
description: MySQL migration request.
properties:
properties:
$ref: '#/definitions/MigrateMySqlRequestProperties'
description: MigrateMySqlRequest resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
PrivateLinkResourceProperties:
type: object
description: Properties of a private link resource
properties:
groupId:
type: string
description: GroupId of a private link resource
readOnly: true
requiredMembers:
type: array
description: RequiredMembers of a private link resource
items:
type: string
readOnly: true
requiredZoneNames:
type: array
description: RequiredZoneNames of a private link resource
items:
type: string
readOnly: true
SnapshotProperties:
type: object
description: Snapshot resource specific properties
properties:
time:
type: string
description: The time the snapshot was taken.
readOnly: true
OpenIdConnectClientCredential:
type: object
description: The authentication client credentials of the custom Open ID Connect provider.
properties:
method:
type: string
description: The method that should be used to authenticate the user.
enum:
- ClientSecretPost
x-ms-enum:
modelAsString: false
clientSecretSettingName:
type: string
description: The app setting that contains the client secret for the custom Open ID Connect provider.
VnetRoute:
type: object
description: Virtual Network route contract used to pass routing information for a Virtual Network.
properties:
properties:
$ref: '#/definitions/VnetRouteProperties'
description: VnetRoute resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
DatabaseType:
type: string
description: Database type (e.g. SqlAzure / MySql).
enum:
- SqlAzure
- MySql
- LocalMySql
- PostgreSql
x-ms-enum:
name: DatabaseType
modelAsString: true
values:
- name: SqlAzure
value: SqlAzure
- name: MySql
value: MySql
- name: LocalMySql
value: LocalMySql
- name: PostgreSql
value: PostgreSql
StorageMigrationResponseProperties:
type: object
description: StorageMigrationResponse resource specific properties
properties:
operationId:
type: string
description: When server starts the migration process, it will return an operation ID identifying that particular migration operation.
readOnly: true
SiteLogsConfigProperties:
type: object
description: SiteLogsConfig resource specific properties
properties:
applicationLogs:
$ref: '#/definitions/ApplicationLogsConfig'
description: Application logs configuration.
httpLogs:
$ref: '#/definitions/HttpLogsConfig'
description: HTTP logs configuration.
failedRequestsTracing:
$ref: '#/definitions/EnabledConfig'
description: Failed requests tracing configuration.
detailedErrorMessages:
$ref: '#/definitions/EnabledConfig'
description: Detailed error messages configuration.
AutoHealTriggers:
type: object
description: Triggers for auto-heal.
properties:
requests:
$ref: '#/definitions/RequestsBasedTrigger'
description: A rule based on total requests.
privateBytesInKB:
type: integer
format: int32
description: A rule based on private bytes.
statusCodes:
type: array
description: A rule based on status codes.
items:
$ref: '#/definitions/StatusCodesBasedTrigger'
x-ms-identifiers:
- path
slowRequests:
$ref: '#/definitions/SlowRequestsBasedTrigger'
description: A rule based on request execution time.
slowRequestsWithPath:
type: array
description: A rule based on multiple Slow Requests Rule with path
items:
$ref: '#/definitions/SlowRequestsBasedTrigger'
x-ms-identifiers:
- path
statusCodesRange:
type: array
description: A rule based on status codes ranges.
items:
$ref: '#/definitions/StatusCodesRangeBasedTrigger'
x-ms-identifiers:
- path
RemotePrivateEndpointConnectionARMResourceProperties:
type: object
description: RemotePrivateEndpointConnectionARMResource resource specific properties
properties:
provisioningState:
type: string
readOnly: true
privateEndpoint:
$ref: '#/definitions/ArmIdWrapper'
description: PrivateEndpoint of a remote private endpoint connection
privateLinkServiceConnectionState:
$ref: '#/definitions/PrivateLinkConnectionState'
description: The state of a private link connection
ipAddresses:
type: array
description: Private IPAddresses mapped to the remote private endpoint
items:
type: string
SiteExtensionType:
type: string
description: Site extension type.
enum:
- Gallery
- WebRoot
x-ms-enum:
name: SiteExtensionType
modelAsString: false
SslState:
type: string
description: SSL type
enum:
- Disabled
- SniEnabled
- IpBasedEnabled
x-ms-enum:
name: SslState
modelAsString: false
ProcessThreadInfo:
type: object
description: Process Thread Information.
properties:
properties:
$ref: '#/definitions/ProcessThreadInfoProperties'
description: ProcessThreadInfo resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
SnapshotRestoreRequest:
type: object
description: Details about app recovery operation.
properties:
properties:
$ref: '#/definitions/SnapshotRestoreRequestProperties'
description: SnapshotRestoreRequest resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
IpSecurityRestriction:
type: object
description: IP security restriction on an app.
properties:
ipAddress:
type: string
description: 'IP address the security restriction is valid for.
It can be in form of pure ipv4 address (required SubnetMask property) or
CIDR notation such as ipv4/mask (leading bit match). For CIDR,
SubnetMask property must not be specified.'
subnetMask:
type: string
description: Subnet mask for the range of IP addresses the restriction is valid for.
vnetSubnetResourceId:
type: string
description: Virtual network resource id
vnetTrafficTag:
type: integer
format: int32
description: (internal) Vnet traffic tag
subnetTrafficTag:
type: integer
format: int32
description: (internal) Subnet traffic tag
action:
type: string
description: Allow or Deny access for this IP range.
tag:
$ref: '#/definitions/IpFilterTag'
description: Defines what this IP filter will be used for. This is to support IP filtering on proxies.
priority:
type: integer
format: int32
description: Priority of IP restriction rule.
name:
type: string
description: IP restriction rule name.
description:
type: string
description: IP restriction rule description.
headers:
type: object
description: 'IP restriction rule headers.
X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples).
The matching logic is ..
- If the property is null or empty (default), all hosts(or lack of) are allowed.
- A value is compared using ordinal-ignore-case (excluding port number).
- Subdomain wildcards are permitted but don''t match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com
but not the root domain contoso.com or multi-level foo.bar.contoso.com
- Unicode host names are allowed but are converted to Punycode for matching.
X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).
The matching logic is ..
- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.
- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.
X-Azure-FDID and X-FD-HealthProbe.
The matching logic is exact match.'
additionalProperties:
items:
type: string
type: array
AuthType:
type: string
description: Auth Type
enum:
- Anonymous
- UserCredentials
- SystemIdentity
- UserAssigned
x-ms-enum:
name: AuthType
modelAsString: false
TriggeredJobHistoryCollection:
type: object
description: Collection of Kudu continuous web job information elements.
properties:
value:
type: array
description: The TriggeredJobHistory items on this page
items:
$ref: '#/definitions/TriggeredJobHistory'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
ProcessThreadInfoProperties:
type: object
description: ProcessThreadInfo resource specific properties
properties:
identifier:
type: integer
format: int32
description: Site extension ID.
readOnly: true
href:
type: string
description: HRef URI.
process:
type: string
description: Process URI.
start_address:
type: string
description: Start address.
x-ms-client-name: startAddress
current_priority:
type: integer
format: int32
description: Current thread priority.
x-ms-client-name: currentPriority
priority_level:
type: string
description: Thread priority level.
x-ms-client-name: priorityLevel
base_priority:
type: integer
format: int32
description: Base priority.
x-ms-client-name: basePriority
start_time:
type: string
format: date-time
description: Start time.
x-ms-client-name: startTime
total_processor_time:
type: string
description: Total processor time.
x-ms-client-name: totalProcessorTime
user_processor_time:
type: string
description: User processor time.
x-ms-client-name: userProcessorTime
state:
type: string
description: Thread state.
wait_reason:
type: string
description: Wait reason.
x-ms-client-name: waitReason
AzureActiveDirectoryRegistration:
type: object
description: The configuration settings of the Azure Active Directory app registration.
properties:
openIdIssuer:
type: string
description: 'The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`.
This URI is a case-sensitive identifier for the token issuer.
More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html'
clientId:
type: string
description: 'The Client ID of this relying party application, known as the client_id.
This setting is required for enabling OpenID Connection authentication with Azure Active Directory or
other 3rd party OpenID Connect providers.
More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html'
clientSecretSettingName:
type: string
description: The app setting name that contains the client secret of the relying party application.
clientSecretCertificateThumbprint:
type: string
description: 'An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as
a replacement for the Client Secret. It is also optional.'
clientSecretCertificateSubjectAlternativeName:
type: string
description: 'An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as
a replacement for the Client Secret Certificate Thumbprint. It is also optional.'
clientSecretCertificateIssuer:
type: string
description: 'An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as
a replacement for the Client Secret Certificate Thumbprint. It is also optional.'
SiteExtensionInfoCollection:
type: object
description: Collection of Kudu site extension information elements.
properties:
value:
type: array
description: The SiteExtensionInfo items on this page
items:
$ref: '#/definitions/SiteExtensionInfo'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
FunctionsDeployment:
type: object
description: Configuration section for the function app deployment.
properties:
storage:
$ref: '#/definitions/FunctionsDeploymentStorage'
description: Storage for deployed package used by the function app.
PremierAddOn:
type: object
description: Premier add-on.
properties:
properties:
$ref: '#/definitions/PremierAddOnProperties'
description: PremierAddOn resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
MigrateMySqlRequestProperties:
type: object
description: MigrateMySqlRequest resource specific properties
properties:
connectionString:
type: string
description: Connection string to the remote MySQL database.
migrationType:
$ref: '#/definitions/MySqlMigrationType'
description: The type of migration operation to be done
required:
- connectionString
- migrationType
SiteContainerProperties:
type: object
description: SiteContainer resource specific properties
properties:
image:
type: string
description: Image Name
targetPort:
type: string
description: Target Port
isMain:
type: boolean
description: true if the container is the main site container; false otherwise.
startUpCommand:
type: string
description: StartUp Command
authType:
$ref: '#/definitions/AuthType'
description: Auth Type
userName:
type: string
description: User Name
passwordSecret:
type: string
description: Password Secret
userManagedIdentityClientId:
type: string
description: UserManagedIdentity ClientId
createdTime:
type: string
format: date-time
description: Created Time
readOnly: true
lastModifiedTime:
type: string
format: date-time
description: Last Modified Time
readOnly: true
volumeMounts:
type: array
description: List of volume mounts
items:
$ref: '#/definitions/VolumeMount'
x-ms-identifiers: []
inheritAppSettingsAndConnectionStrings:
type: boolean
description: true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise.
environmentVariables:
type: array
description: List of environment variables
items:
$ref: '#/definitions/EnvironmentVariable'
required:
- image
- isMain
HttpSettings:
type: object
description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization.
properties:
requireHttps:
type: boolean
description: false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true.
routes:
$ref: '#/definitions/HttpSettingsRoutes'
description: The configuration settings of the paths HTTP requests.
forwardProxy:
$ref: '#/definitions/ForwardProxy'
description: The configuration settings of a forward proxy used to make the requests.
IPMode:
type: string
description: Specifies the IP mode of the app.
enum:
- IPv4
- IPv6
- IPv4AndIPv6
x-ms-enum:
name: IPMode
modelAsString: false
SiteCloneability:
type: object
description: Represents whether or not an app is cloneable.
properties:
result:
$ref: '#/definitions/CloneAbilityResult'
description: Name of app.
blockingFeatures:
type: array
description: List of features enabled on app that prevent cloning.
items:
$ref: '#/definitions/SiteCloneabilityCriterion'
x-ms-identifiers:
- name
unsupportedFeatures:
type: array
description: 'List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned
but the features in this list will not be set up on cloned app.'
items:
$ref: '#/definitions/SiteCloneabilityCriterion'
x-ms-identifiers:
- name
blockingCharacteristics:
type: array
description: List of blocking application characteristics.
items:
$ref: '#/definitions/SiteCloneabilityCriterion'
x-ms-identifiers:
- name
LoginRoutes:
type: object
description: The routes that specify the endpoints used for login and logout requests.
properties:
logoutEndpoint:
type: string
description: The endpoint at which a logout request should be made.
ApiKVReference:
type: object
description: Description of site key vault references.
properties:
properties:
$ref: '#/definitions/ApiKVReferenceProperties'
description: ApiKVReference resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
StatusCodesBasedTrigger:
type: object
description: Trigger based on status code.
properties:
status:
type: integer
format: int32
description: HTTP status code.
subStatus:
type: integer
format: int32
description: Request Sub Status.
win32Status:
type: integer
format: int32
description: Win32 error code.
count:
type: integer
format: int32
description: Request Count.
timeInterval:
type: string
description: Time interval.
path:
type: string
description: Request Path
AzureActiveDirectoryValidation:
type: object
description: The configuration settings of the Azure Active Directory token validation flow.
properties:
jwtClaimChecks:
$ref: '#/definitions/JwtClaimChecks'
description: The configuration settings of the checks that should be made while validating the JWT Claims.
allowedAudiences:
type: array
description: The list of audiences that can make successful authentication/authorization requests.
items:
type: string
defaultAuthorizationPolicy:
$ref: '#/definitions/DefaultAuthorizationPolicy'
description: The configuration settings of the default authorization policy.
TwitterRegistration:
type: object
description: The configuration settings of the app registration for the Twitter provider.
properties:
consumerKey:
type: string
description: 'The OAuth 1.0a consumer key of the Twitter application used for sign-in.
This setting is required for enabling Twitter Sign-In.
Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in'
consumerSecretSettingName:
type: string
description: 'The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
application used for sign-in.'
FunctionEnvelopeCollection:
type: object
description: Collection of Kudu function information elements.
properties:
value:
type: array
description: The FunctionEnvelope items on this page
items:
$ref: '#/definitions/FunctionEnvelope'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
DaprConfig:
type: object
description: App Dapr configuration.
properties:
enabled:
type: boolean
description: Boolean indicating if the Dapr side car is enabled
default: false
appId:
type: string
description: Dapr application identifier
appPort:
type: integer
format: int32
description: Tells Dapr which port your application is listening on
httpReadBufferSize:
type: integer
format: int32
description: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.
httpMaxRequestSize:
type: integer
format: int32
description: Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB.
logLevel:
$ref: '#/definitions/DaprLogLevel'
description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
enableApiLogging:
type: boolean
description: Enables API logging for the Dapr sidecar
MSDeployLogEntry:
type: object
description: MSDeploy log entry
properties:
time:
type: string
format: date-time
description: Timestamp of log entry
readOnly: true
type:
$ref: '#/definitions/MSDeployLogEntryType'
description: Log entry type
readOnly: true
message:
type: string
description: Log entry message
readOnly: true
Site:
type: object
description: A web app, a mobile app backend, or an API app.
properties:
properties:
$ref: '#/definitions/SiteProperties'
description: Site resource specific properties
x-ms-client-flatten: true
identity:
$ref: '#/definitions/ManagedServiceIdentity'
description: Managed service identity.
extendedLocation:
$ref: '#/definitions/ExtendedLocation'
description: Extended Location.
kind:
type: string
description: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
ScmType:
type: string
description: SCM type.
enum:
- None
- Dropbox
- Tfs
- LocalGit
- GitHub
- CodePlexGit
- CodePlexHg
- BitbucketGit
- BitbucketHg
- ExternalGit
- ExternalHg
- OneDrive
- VSO
- VSTSRM
x-ms-enum:
name: ScmType
modelAsString: true
values:
- name: None
value: None
- name: Dropbox
value: Dropbox
- name: Tfs
value: Tfs
- name: LocalGit
value: LocalGit
- name: GitHub
value: GitHub
- name: CodePlexGit
value: CodePlexGit
- name: CodePlexHg
value: CodePlexHg
- name: BitbucketGit
value: BitbucketGit
- name: BitbucketHg
value: BitbucketHg
- name: ExternalGit
value: ExternalGit
- name: ExternalHg
value: ExternalHg
- name: OneDrive
value: OneDrive
- name: VSO
value: VSO
- name: VSTSRM
value: VSTSRM
WorkflowState:
type: string
description: The workflow state.
enum:
- NotSpecified
- Completed
- Enabled
- Disabled
- Deleted
- Suspended
x-ms-enum:
name: WorkflowState
modelAsString: true
values:
- name: NotSpecified
value: NotSpecified
- name: Completed
value: Completed
- name: Enabled
value: Enabled
- name: Disabled
value: Disabled
- name: Deleted
value: Deleted
- name: Suspended
value: Suspended
SitePatchResourceProperties:
type: object
description: SitePatchResource resource specific properties
properties:
state:
type: string
description: Current state of the app.
readOnly: true
hostNames:
type: array
description: Hostnames associated with the app.
items:
type: string
readOnly: true
repositorySiteName:
type: string
description: Name of the repository site.
readOnly: true
usageState:
$ref: '#/definitions/UsageState'
description: State indicating whether the app has exceeded its quota usage. Read-only.
readOnly: true
enabled:
type: boolean
description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
enabledHostNames:
type: array
description: 'Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
the app is not served on those hostnames.'
items:
type: string
readOnly: true
availabilityState:
$ref: '#/definitions/SiteAvailabilityState'
description: Management information availability state for the app.
readOnly: true
hostNameSslStates:
type: array
description: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
items:
$ref: '#/definitions/HostNameSslState'
x-ms-identifiers:
- name
serverFarmId:
type: string
description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".'
reserved:
type: boolean
description: true if reserved; otherwise, false.
default: false
x-ms-mutability:
- read
- create
isXenon:
type: boolean
description: 'Obsolete: Hyper-V sandbox.'
default: false
x-ms-mutability:
- read
- create
hyperV:
type: boolean
description: Hyper-V sandbox.
default: false
x-ms-mutability:
- read
- create
lastModifiedTimeUtc:
type: string
format: date-time
description: Last time the app was modified, in UTC. Read-only.
readOnly: true
dnsConfiguration:
$ref: '#/definitions/SiteDnsConfig'
description: Property to configure various DNS related settings for a site.
siteConfig:
$ref: '#/definitions/SiteConfig'
description: Configuration of the app.
trafficManagerHostNames:
type: array
description: Azure Traffic Manager hostnames associated with the app. Read-only.
items:
type: string
readOnly: true
scmSiteAlsoStopped:
type: boolean
description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
default: false
targetSwapSlot:
type: string
description: Specifies which deployment slot this app will swap into. Read-only.
readOnly: true
hostingEnvironmentProfile:
$ref: '#/definitions/HostingEnvironmentProfile'
description: App Service Environment to use for the app.
x-ms-mutability:
- read
- create
clientAffinityEnabled:
type: boolean
description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.
clientAffinityProxyEnabled:
type: boolean
description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false.
clientCertEnabled:
type: boolean
description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.
clientCertMode:
$ref: '#/definitions/ClientCertMode'
description: 'This composes with ClientCertEnabled setting.
- ClientCertEnabled: false means ClientCert is ignored.
- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.'
clientCertExclusionPaths:
type: string
description: client certificate authentication comma-separated exclusion paths
hostNamesDisabled:
type: boolean
description: true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.
customDomainVerificationId:
type: string
description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.
outboundIpAddresses:
type: string
description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.
readOnly: true
possibleOutboundIpAddresses:
type: string
description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.
readOnly: true
containerSize:
type: integer
format: int32
description: Size of the function container.
dailyMemoryTimeQuota:
type: integer
format: int32
description: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
suspendedTill:
type: string
format: date-time
description: App suspended till in case memory-time quota is exceeded.
readOnly: true
maxNumberOfWorkers:
type: integer
format: int32
description: 'Maximum number of workers.
This only applies to Functions container.'
readOnly: true
cloningInfo:
$ref: '#/definitions/CloningInfo'
description: If specified during app creation, the app is cloned from a source app.
x-ms-mutability:
- create
resourceGroup:
type: string
description: Name of the resource group the app belongs to. Read-only.
readOnly: true
isDefaultContainer:
type: boolean
description: true if the app is a default container; otherwise, false.
readOnly: true
defaultHostName:
type: string
description: Default hostname of the app. Read-only.
readOnly: true
slotSwapStatus:
$ref: '#/definitions/SlotSwapStatus'
description: Status of the last deployment slot swap operation.
readOnly: true
httpsOnly:
type: boolean
description: 'HttpsOnly: configures a web site to accept only https requests. Issues redirect for
http requests'
redundancyMode:
$ref: '#/definitions/RedundancyMode'
description: Site redundancy mode
inProgressOperationId:
type: string
format: uuid
description: Specifies an operation id if this site has a pending operation.
readOnly: true
publicNetworkAccess:
type: string
description: 'Property to allow or block all public traffic. Allowed Values: ''Enabled'', ''Disabled'' or an empty string.'
storageAccountRequired:
type: boolean
description: Checks if Customer provided storage account is required
keyVaultReferenceIdentity:
type: string
description: Identity to use for Key Vault Reference authentication.
virtualNetworkSubnetId:
type: string
description: 'Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.
This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}'
StorageMigrationResponse:
type: object
description: Response for a migration of app content request.
properties:
properties:
$ref: '#/definitions/StorageMigrationResponseProperties'
description: StorageMigrationResponse resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
VolumeMount:
type: object
properties:
volumeSubPath:
type: string
description: Sub path in the volume where volume is mounted from.
containerMountPath:
type: string
description: Target path on the container where volume is mounted on
data:
type: string
description: Config Data to be mounted on the volume
readOnly:
type: boolean
description: Boolean to specify if the mount is read only on the container
required:
- volumeSubPath
- containerMountPath
ProcessModuleInfoCollection:
type: object
description: Collection of Kudu thread information elements.
properties:
value:
type: array
description: The ProcessModuleInfo items on this page
items:
$ref: '#/definitions/ProcessModuleInfo'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
ProxyOnlyResource:
type: object
description: Azure proxy only resource. This resource is not tracked by Azure Resource Manager.
properties:
id:
type: string
description: Resource Id.
readOnly: true
name:
type: string
description: Resource Name.
readOnly: true
kind:
type: string
description: Kind of resource.
type:
type: string
description: Resource type.
readOnly: true
UnauthenticatedClientActionV2:
type: string
description: The action to take when an unauthenticated client attempts to access the app.
enum:
- RedirectToLoginPage
- AllowAnonymous
- Return401
- Return403
x-ms-enum:
name: UnauthenticatedClientActionV2
modelAsString: false
SlotDifference:
type: object
description: A setting difference between two deployment slots of an app.
properties:
properties:
$ref: '#/definitions/SlotDifferenceProperties'
description: SlotDifference resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
SiteProperties:
type: object
description: Site resource specific properties
properties:
state:
type: string
description: Current state of the app.
readOnly: true
hostNames:
type: array
description: Hostnames associated with the app.
items:
type: string
readOnly: true
repositorySiteName:
type: string
description: Name of the repository site.
readOnly: true
usageState:
$ref: '#/definitions/UsageState'
description: State indicating whether the app has exceeded its quota usage. Read-only.
readOnly: true
enabled:
type: boolean
description: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).
enabledHostNames:
type: array
description: 'Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
the app is not served on those hostnames.'
items:
type: string
readOnly: true
availabilityState:
$ref: '#/definitions/SiteAvailabilityState'
description: Management information availability state for the app.
readOnly: true
hostNameSslStates:
type: array
description: Hostname SSL states are used to manage the SSL bindings for app's hostnames.
items:
$ref: '#/definitions/HostNameSslState'
x-ms-identifiers:
- name
serverFarmId:
type: string
description: 'Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".'
reserved:
type: boolean
description: true if reserved; otherwise, false.
default: false
x-ms-mutability:
- read
- create
isXenon:
type: boolean
description: 'Obsolete: Hyper-V sandbox.'
default: false
x-ms-mutability:
- read
- create
hyperV:
type: boolean
description: Hyper-V sandbox.
default: false
x-ms-mutability:
- read
- create
lastModifiedTimeUtc:
type: string
format: date-time
description: Last time the app was modified, in UTC. Read-only.
readOnly: true
dnsConfiguration:
$ref: '#/definitions/SiteDnsConfig'
description: Property to configure various DNS related settings for a site.
outboundVnetRouting:
$ref: '#/definitions/OutboundVnetRouting'
description: Property to configure various outbound traffic routing options over virtual network for a site
siteConfig:
$ref: '#/definitions/SiteConfig'
description: Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information.
x-ms-mutability:
- update
- create
functionAppConfig:
$ref: '#/definitions/FunctionAppConfig'
description: Configuration specific of the Azure Function app.
daprConfig:
$ref: '#/definitions/DaprConfig'
description: Dapr configuration of the app.
workloadProfileName:
type: string
description: Workload profile name for function app to execute on.
resourceConfig:
$ref: '#/definitions/ResourceConfig'
description: Function app resource requirements.
trafficManagerHostNames:
type: array
description: Azure Traffic Manager hostnames associated with the app. Read-only.
items:
type: string
readOnly: true
scmSiteAlsoStopped:
type: boolean
description: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.
default: false
targetSwapSlot:
type: string
description: Specifies which deployment slot this app will swap into. Read-only.
readOnly: true
hostingEnvironmentProfile:
$ref: '#/definitions/HostingEnvironmentProfile'
description: App Service Environment to use for the app.
x-ms-mutability:
- read
- create
clientAffinityEnabled:
type: boolean
description: true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.
default: false
clientAffinityPartitioningEnabled:
type: boolean
description: true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false.
clientAffinityProxyEnabled:
type: boolean
description: true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false.
clientCertEnabled:
type: boolean
description: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.
clientCertMode:
$ref: '#/definitions/ClientCertMode'
description: 'This composes with ClientCertEnabled setting.
- ClientCertEnabled: false means ClientCert is ignored.
- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.'
clientCertExclusionPaths:
type: string
description: client certificate authentication comma-separated exclusion paths
ipMode:
$ref: '#/definitions/IPMode'
description: Specifies the IP mode of the app.
endToEndEncryptionEnabled:
type: boolean
description: Whether to use end to end encryption between the FrontEnd and the Worker
sshEnabled:
type: boolean
description: Whether to enable ssh access.
hostNamesDisabled:
type: boolean
description: 'true to disable the public hostnames of the app; otherwise, false.
If true, the app is only accessible via API management process.'
customDomainVerificationId:
type: string
description: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.
outboundIpAddresses:
type: string
description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.
readOnly: true
possibleOutboundIpAddresses:
type: string
description: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.
readOnly: true
containerSize:
type: integer
format: int32
description: Size of the function container.
dailyMemoryTimeQuota:
type: integer
format: int32
description: Maximum allowed daily memory-time quota (applicable on dynamic apps only).
suspendedTill:
type: string
format: date-time
description: App suspended till in case memory-time quota is exceeded.
readOnly: true
maxNumberOfWorkers:
type: integer
format: int32
description: 'Maximum number of workers.
This only applies to Functions container.'
readOnly: true
cloningInfo:
$ref: '#/definitions/CloningInfo'
description: If specified during app creation, the app is cloned from a source app.
x-ms-mutability:
- create
resourceGroup:
type: string
description: Name of the resource group the app belongs to. Read-only.
readOnly: true
isDefaultContainer:
type: boolean
description: true if the app is a default container; otherwise, false.
readOnly: true
defaultHostName:
type: string
description: Default hostname of the app. Read-only.
readOnly: true
slotSwapStatus:
$ref: '#/definitions/SlotSwapStatus'
description: Status of the last deployment slot swap operation.
readOnly: true
httpsOnly:
type: boolean
description: 'HttpsOnly: configures a web site to accept only https requests. Issues redirect for
http requests'
redundancyMode:
$ref: '#/definitions/RedundancyMode'
description: Site redundancy mode
inProgressOperationId:
type: string
format: uuid
description: Specifies an operation id if this site has a pending operation.
readOnly: true
publicNetworkAccess:
type: string
description: 'Property to allow or block all public traffic. Allowed Values: ''Enabled'', ''Disabled'' or an empty string.'
storageAccountRequired:
type: boolean
description: Checks if Customer provided storage account is required
keyVaultReferenceIdentity:
type: string
description: Identity to use for Key Vault Reference authentication.
autoGeneratedDomainNameLabelScope:
$ref: '#/definitions/AutoGeneratedDomainNameLabelScope'
description: Specifies the scope of uniqueness for the default hostname during resource creation
virtualNetworkSubnetId:
type: string
description: 'Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.
This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}'
managedEnvironmentId:
type: string
description: Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}
sku:
type: string
description: Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2
readOnly: true
AzureStorageProtocol:
type: string
description: Mounting protocol to use for the storage account.
enum:
- Smb
- Http
- Nfs
x-ms-enum:
name: AzureStorageProtocol
modelAsString: true
values:
- name: Smb
value: Smb
- name: Http
value: Http
- name: Nfs
value: Nfs
FunctionsScaleAndConcurrencyTriggersHttp:
type: object
description: Scale and concurrency settings for the HTTP trigger.
properties:
perInstanceConcurrency:
type: integer
format: int32
description: The maximum number of concurrent HTTP trigger invocations per instance.
GitHub:
type: object
description: The configuration settings of the GitHub provider.
properties:
enabled:
type: boolean
description: false if the GitHub provider should not be enabled despite the set registration; otherwise, true.
registration:
$ref: '#/definitions/ClientRegistration'
description: The configuration settings of the app registration for the GitHub provider.
login:
$ref: '#/definitions/LoginScopes'
description: The configuration settings of the login flow.
CustomHostNameDnsRecordType:
type: string
description: Custom DNS record type.
enum:
- CName
- A
x-ms-enum:
name: CustomHostNameDnsRecordType
modelAsString: false
MSDeployStatusProperties:
type: object
description: MSDeployStatus resource specific properties
properties:
deployer:
type: string
description: Username of deployer
readOnly: true
provisioningState:
$ref: '#/definitions/MSDeployProvisioningState'
description: Provisioning state
readOnly: true
startTime:
type: string
format: date-time
description: Start time of deploy operation
readOnly: true
endTime:
type: string
format: date-time
description: End time of deploy operation
readOnly: true
complete:
type: boolean
description: Whether the deployment operation has completed
readOnly: true
SnapshotCollection:
type: object
description: Collection of snapshots which can be used to revert an app to a previous time.
properties:
value:
type: array
description: The Snapshot items on this page
items:
$ref: '#/definitions/Snapshot'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
WebJobCollection:
type: object
description: Collection of Kudu web job information elements.
properties:
value:
type: array
description: The WebJob items on this page
items:
$ref: '#/definitions/WebJob'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
SiteMachineKey:
type: object
description: MachineKey of an app.
properties:
validation:
type: string
description: MachineKey validation.
validationKey:
type: string
description: Validation key.
decryption:
type: string
description: Algorithm used for decryption.
decryptionKey:
type: string
description: Decryption key.
FunctionsDeploymentStorageType:
type: string
description: 'Property to select Azure Storage type. Available options: blobContainer.'
enum:
- blobContainer
x-ms-enum:
name: FunctionsDeploymentStorageType
modelAsString: true
values:
- name: blobContainer
value: blobContainer
MSDeployLog:
type: object
description: MSDeploy log
properties:
properties:
$ref: '#/definitions/MSDeployLogProperties'
description: MSDeployLog resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
VirtualApplication:
type: object
description: Virtual application in an app.
properties:
virtualPath:
type: string
description: Virtual path.
physicalPath:
type: string
description: Physical path.
preloadEnabled:
type: boolean
description: true if preloading is enabled; otherwise, false.
virtualDirectories:
type: array
description: Virtual directories for virtual application.
items:
$ref: '#/definitions/VirtualDirectory'
x-ms-identifiers:
- virtualPath
FunctionAppConfig:
type: object
description: Function app configuration.
properties:
deployment:
$ref: '#/definitions/FunctionsDeployment'
description: Function app deployment configuration.
runtime:
$ref: '#/definitions/FunctionsRuntime'
description: Function app runtime settings.
scaleAndConcurrency:
$ref: '#/definitions/FunctionsScaleAndConcurrency'
description: Function app scale and concurrency settings.
siteUpdateStrategy:
$ref: '#/definitions/FunctionsSiteUpdateStrategy'
description: Function app site update strategy configuration.
FileSystemApplicationLogsConfig:
type: object
description: Application logs to file system configuration.
properties:
level:
type: string
description: Log level.
default: 'Off'
enum:
- 'Off'
- Verbose
- Information
- Warning
- Error
x-ms-enum:
name: LogLevel
modelAsString: false
SiteDnsConfig:
type: object
properties:
dnsServers:
type: array
description: List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set.
items:
type: string
dnsAltServer:
type: string
description: Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting.
dnsRetryAttemptTimeout:
type: integer
format: int32
description: 'Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3.'
dnsRetryAttemptCount:
type: integer
format: int32
description: 'Total number of retries for dns lookup. Allowed range: 1-5. Default is 3.'
dnsMaxCacheTimeout:
type: integer
format: int32
description: 'Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled.'
dnsLegacySortOrder:
type: boolean
description: Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only.
readOnly: true
SlotConfigNamesResource:
type: object
description: Slot Config names azure resource.
properties:
properties:
$ref: '#/definitions/SlotConfigNames'
description: Core resource properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
PremierAddOnPatchResource:
type: object
description: ARM resource for a PremierAddOn.
properties:
properties:
$ref: '#/definitions/PremierAddOnPatchResourceProperties'
description: PremierAddOnPatchResource resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
MSDeployCore:
type: object
description: MSDeploy ARM PUT core information
properties:
packageUri:
type: string
description: Package URI
connectionString:
type: string
description: SQL Connection String
dbType:
type: string
description: Database Type
setParametersXmlFileUri:
type: string
description: URI of MSDeploy Parameters file. Must not be set if SetParameters is used.
setParameters:
type: object
description: MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.
additionalProperties:
type: string
skipAppData:
type: boolean
description: 'Controls whether the MSDeploy operation skips the App_Data directory.
If set to true, the existing App_Data directory on the destination
will not be deleted, and any App_Data directory in the source will be ignored.
Setting is false by default.'
appOffline:
type: boolean
description: 'Sets the AppOffline rule while the MSDeploy operation executes.
Setting is false by default.'
MigrateMySqlStatus:
type: object
description: MySQL migration status.
properties:
properties:
$ref: '#/definitions/MigrateMySqlStatusProperties'
description: MigrateMySqlStatus resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
RestoreRequestProperties:
type: object
description: RestoreRequest resource specific properties
properties:
storageAccountUrl:
type: string
description: SAS URL to the container.
blobName:
type: string
description: Name of a blob which contains the backup.
overwrite:
type: boolean
description: true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.
siteName:
type: string
description: Name of an app.
databases:
type: array
description: Collection of databases which should be restored. This list has to match the list of databases included in the backup.
items:
$ref: '#/definitions/DatabaseBackupSetting'
x-ms-identifiers:
- name
ignoreConflictingHostNames:
type: boolean
description: Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to \nthe app's object when it is being restored, but that might fail due to conflicts during the operation.
default: false
ignoreDatabases:
type: boolean
description: Ignore the databases and only restore the site content
default: false
appServicePlan:
type: string
description: Specify app service plan that will own restored site.
operationType:
type: string
description: Operation type.
default: Default
enum:
- Default
- Clone
- Relocation
- Snapshot
- CloudFS
x-ms-enum:
name: BackupRestoreOperationType
modelAsString: false
adjustConnectionStrings:
type: boolean
description: true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.
hostingEnvironment:
type: string
description: App Service Environment name, if needed (only when restoring an app to an App Service Environment).
required:
- storageAccountUrl
- overwrite
FunctionsDeploymentStorage:
type: object
description: Storage for deployed package used by the function app.
properties:
type:
$ref: '#/definitions/FunctionsDeploymentStorageType'
description: 'Property to select Azure Storage type. Available options: blobContainer.'
value:
type: string
format: uri
description: 'Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/.'
authentication:
$ref: '#/definitions/FunctionsDeploymentStorageAuthentication'
description: Authentication method to access the storage account for deployment.
ContinuousWebJobCollection:
type: object
description: Collection of Kudu continuous web job information elements.
properties:
value:
type: array
description: The ContinuousWebJob items on this page
items:
$ref: '#/definitions/ContinuousWebJob'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
SiteAuthSettingsProperties:
type: object
description: SiteAuthSettings resource specific properties
properties:
enabled:
type: boolean
description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
runtimeVersion:
type: string
description: 'The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
The setting in this value can control the behavior of certain features in the Authentication / Authorization module.'
unauthenticatedClientAction:
$ref: '#/definitions/UnauthenticatedClientAction'
description: The action to take when an unauthenticated client attempts to access the app.
tokenStoreEnabled:
type: boolean
description: 'true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.
The default is false.'
allowedExternalRedirectUrls:
type: array
description: 'External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.
This is an advanced setting typically only needed by Windows Store application backends.
Note that URLs within the current domain are always implicitly allowed.'
items:
type: string
defaultProvider:
$ref: '#/definitions/BuiltInAuthenticationProvider'
description: 'The default authentication provider to use when multiple providers are configured.
This setting is only needed if multiple providers are configured and the unauthenticated client
action is set to "RedirectToLoginPage".'
tokenRefreshExtensionHours:
type: number
format: double
description: 'The number of hours after session token expiration that a session token can be used to
call the token refresh API. The default is 72 hours.'
clientId:
type: string
description: 'The Client ID of this relying party application, known as the client_id.
This setting is required for enabling OpenID Connection authentication with Azure Active Directory or
other 3rd party OpenID Connect providers.
More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html'
clientSecret:
type: string
description: 'The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).
This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.
Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.
More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html'
clientSecretSettingName:
type: string
description: The app setting name that contains the client secret of the relying party application.
clientSecretCertificateThumbprint:
type: string
description: 'An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as
a replacement for the Client Secret. It is also optional.'
issuer:
type: string
description: 'The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`.
This URI is a case-sensitive identifier for the token issuer.
More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html'
validateIssuer:
type: boolean
description: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
allowedAudiences:
type: array
description: 'Allowed audience values to consider when validating JSON Web Tokens issued by
Azure Active Directory. Note that the ClientID value is always considered an
allowed audience, regardless of this setting.'
items:
type: string
additionalLoginParams:
type: array
description: 'Login parameters to send to the OpenID Connect authorization endpoint when
a user logs in. Each parameter must be in the form "key=value".'
items:
type: string
aadClaimsAuthorization:
type: string
description: Gets a JSON string containing the Azure AD Acl settings.
googleClientId:
type: string
description: 'The OpenID Connect Client ID for the Google web application.
This setting is required for enabling Google Sign-In.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/'
googleClientSecret:
type: string
description: 'The client secret associated with the Google web application.
This setting is required for enabling Google Sign-In.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/'
googleClientSecretSettingName:
type: string
description: 'The app setting name that contains the client secret associated with
the Google web application.'
googleOAuthScopes:
type: array
description: 'The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes.
Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/'
items:
type: string
facebookAppId:
type: string
description: 'The App ID of the Facebook app used for login.
This setting is required for enabling Facebook Login.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login'
facebookAppSecret:
type: string
description: 'The App Secret of the Facebook app used for Facebook Login.
This setting is required for enabling Facebook Login.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login'
facebookAppSecretSettingName:
type: string
description: The app setting name that contains the app secret used for Facebook Login.
facebookOAuthScopes:
type: array
description: 'The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
This setting is optional.
Facebook Login documentation: https://developers.facebook.com/docs/facebook-login'
items:
type: string
gitHubClientId:
type: string
description: 'The Client Id of the GitHub app used for login.
This setting is required for enabling Github login'
gitHubClientSecret:
type: string
description: 'The Client Secret of the GitHub app used for Github Login.
This setting is required for enabling Github login.'
gitHubClientSecretSettingName:
type: string
description: 'The app setting name that contains the client secret of the Github
app used for GitHub Login.'
gitHubOAuthScopes:
type: array
description: 'The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
This setting is optional'
items:
type: string
twitterConsumerKey:
type: string
description: 'The OAuth 1.0a consumer key of the Twitter application used for sign-in.
This setting is required for enabling Twitter Sign-In.
Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in'
twitterConsumerSecret:
type: string
description: 'The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
This setting is required for enabling Twitter Sign-In.
Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in'
twitterConsumerSecretSettingName:
type: string
description: 'The app setting name that contains the OAuth 1.0a consumer secret of the Twitter
application used for sign-in.'
microsoftAccountClientId:
type: string
description: 'The OAuth 2.0 client ID that was created for the app used for authentication.
This setting is required for enabling Microsoft Account authentication.
Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm'
microsoftAccountClientSecret:
type: string
description: 'The OAuth 2.0 client secret that was created for the app used for authentication.
This setting is required for enabling Microsoft Account authentication.
Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm'
microsoftAccountClientSecretSettingName:
type: string
description: 'The app setting name containing the OAuth 2.0 client secret that was created for the
app used for authentication.'
microsoftAccountOAuthScopes:
type: array
description: 'The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
This setting is optional. If not specified, "wl.basic" is used as the default scope.
Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx'
items:
type: string
isAuthFromFile:
type: string
description: '"true" if the auth config settings should be read from a file,
"false" otherwise'
authFilePath:
type: string
description: 'The path of the config file containing auth settings.
If the path is relative, base will the site''s root directory.'
configVersion:
type: string
description: 'The ConfigVersion of the Authentication / Authorization feature in use for the current app.
The setting in this value can control the behavior of the control plane for Authentication / Authorization.'
FunctionsScaleAndConcurrencyTriggers:
type: object
description: Scale and concurrency settings for the function app triggers.
properties:
http:
$ref: '#/definitions/FunctionsScaleAndConcurrencyTriggersHttp'
description: Scale and concurrency settings for the HTTP trigger.
RuntimeName:
type: string
description: 'Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom'
enum:
- dotnet-isolated
- node
- java
- powershell
- python
- custom
x-ms-enum:
name: RuntimeName
modelAsString: true
values:
- name: dotnet-isolated
value: dotnet-isolated
- name: node
value: node
- name: java
value: java
- name: powershell
value: powershell
- name: python
value: python
- name: custom
value: custom
BackupItem:
type: object
description: Backup description.
properties:
properties:
$ref: '#/definitions/BackupItemProperties'
description: BackupItem resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
RampUpRule:
type: object
description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.
properties:
actionHostName:
type: string
description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.
reroutePercentage:
type: number
format: double
description: Percentage of the traffic which will be redirected to ActionHostName.
changeStep:
type: number
format: double
description: 'In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or
MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm
can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.'
changeIntervalInMinutes:
type: integer
format: int32
description: Specifies interval in minutes to reevaluate ReroutePercentage.
minReroutePercentage:
type: number
format: double
description: Specifies lower boundary above which ReroutePercentage will stay.
maxReroutePercentage:
type: number
format: double
description: Specifies upper boundary below which ReroutePercentage will stay.
changeDecisionCallbackUrl:
type: string
description: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified.
name:
type: string
description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.
AzureStorageInfoValue:
type: object
description: Azure Files or Blob Storage access information value for dictionary storage.
properties:
type:
$ref: '#/definitions/AzureStorageType'
description: Type of storage.
accountName:
type: string
description: Name of the storage account.
shareName:
type: string
description: Name of the file share (container name, for Blob storage).
accessKey:
type: string
format: password
description: Access key for the storage account.
x-ms-secret: true
mountPath:
type: string
description: Path to mount the storage within the site's runtime environment.
state:
$ref: '#/definitions/AzureStorageState'
description: State of the storage account.
readOnly: true
protocol:
$ref: '#/definitions/AzureStorageProtocol'
description: Mounting protocol to use for the storage account.
CsmDeploymentStatus:
type: object
description: Deployment status response payload.
properties:
properties:
$ref: '#/definitions/CsmDeploymentStatusProperties'
description: CsmDeploymentStatus resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
ProcessInfo:
type: object
description: Process Information.
properties:
properties:
$ref: '#/definitions/ProcessInfoProperties'
description: ProcessInfo resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
CookieExpirationConvention:
type: string
description: The convention used when determining the session cookie's expiration.
enum:
- FixedTime
- IdentityProviderDerived
x-ms-enum:
name: CookieExpirationConvention
modelAsString: false
SiteConfigurationSnapshotInfoCollection:
type: object
description: Collection of metadata for the app configuration snapshots that can be restored.
properties:
value:
type: array
description: The SiteConfigurationSnapshotInfo items on this page
items:
$ref: '#/definitions/SiteConfigurationSnapshotInfo'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
SlotDifferenceCollection:
type: object
description: Collection of slot differences.
properties:
value:
type: array
description: The SlotDifference items on this page
items:
$ref: '#/definitions/SlotDifference'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
AzureStorageType:
type: string
description: Type of storage.
enum:
- AzureFiles
- AzureBlob
x-ms-enum:
name: AzureStorageType
modelAsString: false
Snapshot:
type: object
description: A snapshot of an app.
properties:
properties:
$ref: '#/definitions/SnapshotProperties'
description: Snapshot resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
MySqlMigrationType:
type: string
description: The type of migration operation to be done
enum:
- LocalToRemote
- RemoteToLocal
x-ms-enum:
name: MySqlMigrationType
modelAsString: false
WebAppCollection:
type: object
description: Collection of App Service apps.
properties:
value:
type: array
description: The Site items on this page
items:
$ref: '#/definitions/Site'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
NetworkTrace:
type: object
description: Network trace
properties:
path:
type: string
description: Local file path for the captured network trace file.
status:
type: string
description: Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed).
message:
type: string
description: Detailed message of a network trace operation, e.g. error message in case of failure.
SiteCloneabilityCriterion:
type: object
description: An app cloneability criterion.
properties:
name:
type: string
description: Name of criterion.
description:
type: string
description: Description of criterion.
FunctionsRuntime:
type: object
description: Function app runtime name and version.
properties:
name:
$ref: '#/definitions/RuntimeName'
description: 'Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom'
version:
type: string
description: 'Function app runtime version. Example: 8 (for dotnet-isolated)'
x-nullable: true
RemotePrivateEndpointConnectionARMResource:
type: object
description: Remote Private Endpoint Connection ARM resource.
properties:
properties:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResourceProperties'
description: RemotePrivateEndpointConnectionARMResource resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
OutboundVnetRouting:
type: object
description: Outbound traffic options over virtual network.
properties:
allTraffic:
type: boolean
description: Enables all other routing options defined in OutboundVnetRouting if this setting is set to true.
applicationTraffic:
type: boolean
description: This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled.
contentShareTraffic:
type: boolean
description: Enables accessing content over virtual network. Previously called VnetContentShareEnabled
imagePullTraffic:
type: boolean
description: Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled.
backupRestoreTraffic:
type: boolean
description: Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled
AzureStoragePropertyDictionaryResource:
type: object
description: AzureStorageInfo dictionary resource.
properties:
properties:
type: object
description: Azure storage accounts.
additionalProperties:
$ref: '#/definitions/AzureStorageInfoValue'
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
TriggeredJobHistoryProperties:
type: object
description: TriggeredJobHistory resource specific properties
properties:
runs:
type: array
description: List of triggered web job runs.
items:
$ref: '#/definitions/TriggeredJobRun'
x-ms-identifiers:
- web_job_id
AutoHealCustomAction:
type: object
description: 'Custom action to be executed
when an auto heal rule is triggered.'
properties:
exe:
type: string
description: Executable to be run.
parameters:
type: string
description: Parameters for the executable.
HostNameBindingCollection:
type: object
description: Collection of hostname bindings.
properties:
value:
type: array
description: The HostNameBinding items on this page
items:
$ref: '#/definitions/HostNameBinding'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
ContinuousWebJob:
type: object
description: Continuous Web Job Information.
properties:
properties:
$ref: '#/definitions/ContinuousWebJobProperties'
description: ContinuousWebJob resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
WorkflowEnvelopeCollection:
type: object
description: Collection of Kudu workflow information elements.
properties:
value:
type: array
description: The WorkflowEnvelope items on this page
items:
$ref: '#/definitions/WorkflowEnvelope'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
WorkflowArtifacts:
type: object
description: The workflow filter.
properties:
appSettings:
description: Application settings of the workflow.
files:
type: object
description: Files of the app.
additionalProperties: {}
filesToDelete:
type: array
description: Files of the app to delete.
items:
type: string
DatabaseBackupSetting:
type: object
description: Database backup settings.
properties:
databaseType:
$ref: '#/definitions/DatabaseType'
description: Database type (e.g. SqlAzure / MySql).
name:
type: string
connectionStringName:
type: string
description: 'Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.
This is used during restore with overwrite connection strings options.'
connectionString:
type: string
description: Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
required:
- databaseType
FileSystemTokenStore:
type: object
description: The configuration settings of the storage of the tokens if a file system is used.
properties:
directory:
type: string
description: The directory in which the tokens will be stored.
PrivateAccessSubnet:
type: object
description: Description of a Virtual Network subnet that is useable for private site access.
properties:
name:
type: string
description: The name of the subnet.
key:
type: integer
format: int32
description: The key (ID) of the subnet.
CsmPublishingCredentialsPoliciesEntity:
type: object
description: Publishing Credentials Policies parameters.
properties:
properties:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntityProperties'
description: CsmPublishingCredentialsPoliciesEntity resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
HandlerMapping:
type: object
description: 'The IIS handler mappings used to define which handler processes HTTP requests with certain extension.
For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.'
properties:
extension:
type: string
description: Requests with this extension will be handled using the specified FastCGI application.
scriptProcessor:
type: string
description: The absolute path to the FastCGI application.
arguments:
type: string
description: Command-line arguments to be passed to the script processor.
BuiltInAuthenticationProvider:
type: string
description: 'The default authentication provider to use when multiple providers are configured.
This setting is only needed if multiple providers are configured and the unauthenticated client
action is set to "RedirectToLoginPage".'
enum:
- AzureActiveDirectory
- Facebook
- Google
- MicrosoftAccount
- Twitter
- Github
x-ms-enum:
name: BuiltInAuthenticationProvider
modelAsString: false
PublicCertificateCollection:
type: object
description: Collection of public certificates
properties:
value:
type: array
description: The PublicCertificate items on this page
items:
$ref: '#/definitions/PublicCertificate'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
PublishingProfileFormat:
type: string
description: 'Name of the format. Valid values are:
FileZilla3
WebDeploy -- default
Ftp'
enum:
- FileZilla3
- WebDeploy
- Ftp
x-ms-enum:
name: PublishingProfileFormat
modelAsString: true
values:
- name: FileZilla3
value: FileZilla3
- name: WebDeploy
value: WebDeploy
- name: Ftp
value: Ftp
AzureStorageState:
type: string
description: State of the storage account.
enum:
- Ok
- InvalidCredentials
- InvalidShare
- NotValidated
x-ms-enum:
name: AzureStorageState
modelAsString: false
HostNameBindingProperties:
type: object
description: HostNameBinding resource specific properties
properties:
siteName:
type: string
description: App Service app name.
x-ms-mutability:
- read
- create
domainId:
type: string
description: Fully qualified ARM domain resource URI.
x-ms-mutability:
- read
- create
azureResourceName:
type: string
description: Azure resource name.
x-ms-mutability:
- read
- create
azureResourceType:
$ref: '#/definitions/AzureResourceType'
description: Azure resource type.
x-ms-mutability:
- read
- create
customHostNameDnsRecordType:
$ref: '#/definitions/CustomHostNameDnsRecordType'
description: Custom DNS record type.
x-ms-mutability:
- read
- create
hostNameType:
$ref: '#/definitions/HostNameType'
description: Hostname type.
x-ms-mutability:
- read
- create
sslState:
$ref: '#/definitions/SslState'
description: SSL type
x-ms-mutability:
- read
- create
thumbprint:
type: string
description: SSL certificate thumbprint
x-ms-mutability:
- read
- create
virtualIP:
type: string
description: Virtual IP address assigned to the hostname if IP based SSL is enabled.
readOnly: true
OpenIdConnectLogin:
type: object
description: The configuration settings of the login flow of the custom Open ID Connect provider.
properties:
nameClaimType:
type: string
description: The name of the claim that contains the users name.
scopes:
type: array
description: A list of the scopes that should be requested while authenticating.
items:
type: string
StorageMigrationOptionsProperties:
type: object
description: StorageMigrationOptions resource specific properties
properties:
azurefilesConnectionString:
type: string
description: AzureFiles connection string.
x-ms-mutability:
- create
azurefilesShare:
type: string
description: AzureFiles share.
x-ms-mutability:
- create
switchSiteAfterMigration:
type: boolean
description: trueif the app should be switched over; otherwise, false.
default: false
x-ms-mutability:
- create
blockWriteAccessToSite:
type: boolean
description: true if the app should be read only during copy operation; otherwise, false.
default: false
x-ms-mutability:
- create
required:
- azurefilesConnectionString
- azurefilesShare
SiteLoadBalancing:
type: string
description: Site load balancing.
enum:
- WeightedRoundRobin
- LeastRequests
- LeastResponseTime
- WeightedTotalTraffic
- RequestHash
- PerSiteRoundRobin
- LeastRequestsWithTieBreaker
x-ms-enum:
name: SiteLoadBalancing
modelAsString: false
AzureBlobStorageApplicationLogsConfig:
type: object
description: Application logs azure blob storage configuration.
properties:
level:
$ref: '#/definitions/LogLevel'
description: Log level.
sasUrl:
type: string
description: SAS url to a azure blob container with read/write/list/delete permissions.
retentionInDays:
type: integer
format: int32
description: 'Retention in days.
Remove blobs older than X days.
0 or lower means no retention.'
NetworkFeaturesProperties:
type: object
description: NetworkFeatures resource specific properties
properties:
virtualNetworkName:
type: string
description: The Virtual Network name.
readOnly: true
virtualNetworkConnection:
$ref: '#/definitions/VnetInfo'
description: The Virtual Network summary view.
readOnly: true
hybridConnections:
type: array
description: The Hybrid Connections summary view.
items:
$ref: '#/definitions/RelayServiceConnectionEntity'
readOnly: true
hybridConnectionsV2:
type: array
description: The Hybrid Connection V2 (Service Bus) view.
items:
$ref: '#/definitions/HybridConnection'
readOnly: true
OpenIdConnectRegistration:
type: object
description: The configuration settings of the app registration for the custom Open ID Connect provider.
properties:
clientId:
type: string
description: The client id of the custom Open ID Connect provider.
clientCredential:
$ref: '#/definitions/OpenIdConnectClientCredential'
description: The authentication credentials of the custom Open ID Connect provider.
openIdConnectConfiguration:
$ref: '#/definitions/OpenIdConnectConfig'
description: The configuration settings of the endpoints used for the custom Open ID Connect provider.
SiteSourceControlProperties:
type: object
description: SiteSourceControl resource specific properties
properties:
repoUrl:
type: string
description: Repository or source control URL.
x-ms-mutability:
- read
- create
branch:
type: string
description: Name of branch to use for deployment.
x-ms-mutability:
- read
- create
isManualIntegration:
type: boolean
description: true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).
x-ms-mutability:
- read
- create
isGitHubAction:
type: boolean
description: true if this is deployed via GitHub action.
x-ms-mutability:
- read
- create
deploymentRollbackEnabled:
type: boolean
description: true to enable deployment rollback; otherwise, false.
x-ms-mutability:
- read
- create
isMercurial:
type: boolean
description: true for a Mercurial repository; false for a Git repository.
x-ms-mutability:
- read
- create
gitHubActionConfiguration:
$ref: '#/definitions/GitHubActionConfiguration'
description: If GitHub Action is selected, than the associated configuration.
WebAppInstanceStatusCollection:
type: object
description: Collection of app instances.
properties:
value:
type: array
description: The WebSiteInstanceStatus items on this page
items:
$ref: '#/definitions/WebSiteInstanceStatus'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
ContainerNetworkInterfaceStatistics:
type: object
properties:
rxBytes:
type: integer
format: int64
rxPackets:
type: integer
format: int64
rxErrors:
type: integer
format: int64
rxDropped:
type: integer
format: int64
txBytes:
type: integer
format: int64
txPackets:
type: integer
format: int64
txErrors:
type: integer
format: int64
txDropped:
type: integer
format: int64
ContainerMemoryStatistics:
type: object
properties:
usage:
type: integer
format: int64
maxUsage:
type: integer
format: int64
limit:
type: integer
format: int64
SlotDifferenceProperties:
type: object
description: SlotDifference resource specific properties
properties:
level:
type: string
description: 'Level of the difference: Information, Warning or Error.'
readOnly: true
settingType:
type: string
description: 'The type of the setting: General, AppSetting or ConnectionString.'
readOnly: true
diffRule:
type: string
description: Rule that describes how to process the setting difference during a slot swap.
readOnly: true
settingName:
type: string
description: Name of the setting.
readOnly: true
valueInCurrentSlot:
type: string
description: Value of the setting in the current slot.
readOnly: true
valueInTargetSlot:
type: string
description: Value of the setting in the target slot.
readOnly: true
description:
type: string
description: Description of the setting difference.
readOnly: true
ManagedPipelineMode:
type: string
description: Managed pipeline mode.
enum:
- Integrated
- Classic
x-ms-enum:
name: ManagedPipelineMode
modelAsString: false
KeyInfo:
type: object
description: Function key info.
properties:
name:
type: string
description: Key name
value:
type: string
description: Key value
AzureActiveDirectoryLogin:
type: object
description: The configuration settings of the Azure Active Directory login flow.
properties:
loginParameters:
type: array
description: 'Login parameters to send to the OpenID Connect authorization endpoint when
a user logs in. Each parameter must be in the form "key=value".'
items:
type: string
disableWWWAuthenticate:
type: boolean
description: true if the www-authenticate provider should be omitted from the request; otherwise, false.
AzureStaticWebApps:
type: object
description: The configuration settings of the Azure Static Web Apps provider.
properties:
enabled:
type: boolean
description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true.
registration:
$ref: '#/definitions/AzureStaticWebAppsRegistration'
description: The configuration settings of the Azure Static Web Apps registration.
ApiKVReferenceProperties:
type: object
description: ApiKVReference resource specific properties
properties:
reference:
type: string
status:
$ref: '#/definitions/ResolveStatus'
vaultName:
type: string
secretName:
type: string
secretVersion:
type: string
identityType:
$ref: '#/definitions/ManagedServiceIdentity'
description: Managed service identity.
details:
type: string
source:
type: string
enum:
- KeyVault
x-ms-enum:
modelAsString: false
activeVersion:
type: string
RequestsBasedTrigger:
type: object
description: Trigger based on total requests.
properties:
count:
type: integer
format: int32
description: Request Count.
timeInterval:
type: string
description: Time interval.
CsmSlotEntity:
type: object
description: Deployment slot parameters.
properties:
targetSlot:
type: string
description: Destination deployment slot during swap operation.
preserveVnet:
type: boolean
description: true to preserve Virtual Network to the slot during swap; otherwise, false.
required:
- targetSlot
- preserveVnet
HttpLogsConfig:
type: object
description: Http logs configuration.
properties:
fileSystem:
$ref: '#/definitions/FileSystemHttpLogsConfig'
description: Http logs to file system configuration.
azureBlobStorage:
$ref: '#/definitions/AzureBlobStorageHttpLogsConfig'
description: Http logs to azure blob storage configuration.
CorsSettings:
type: object
description: Cross-Origin Resource Sharing (CORS) settings for the app.
properties:
allowedOrigins:
type: array
description: 'Gets or sets the list of origins that should be allowed to make cross-origin
calls (for example: http://example.com:12345). Use "*" to allow all.'
items:
type: string
supportCredentials:
type: boolean
description: 'Gets or sets whether CORS requests with credentials are allowed. See
https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials
for more details.'
ConnStringInfo:
type: object
description: Database connection string information.
properties:
name:
type: string
description: Name of connection string.
connectionString:
type: string
description: Connection string value.
type:
$ref: '#/definitions/ConnectionStringType'
description: Type of database.
PerfMonSample:
type: object
description: Performance monitor sample in a set.
properties:
time:
type: string
format: date-time
description: Point in time for which counter was measured.
instanceName:
type: string
description: Name of the server on which the measurement is made.
value:
type: number
format: double
description: Value of counter at a certain time.
CsmDeploymentStatusProperties:
type: object
description: CsmDeploymentStatus resource specific properties
properties:
deploymentId:
type: string
description: Deployment operation id.
status:
$ref: '#/definitions/DeploymentBuildStatus'
description: Deployment build status.
numberOfInstancesInProgress:
type: integer
format: int32
description: Number of site instances currently being provisioned.
numberOfInstancesSuccessful:
type: integer
format: int32
description: Number of site instances provisioned successfully.
numberOfInstancesFailed:
type: integer
format: int32
description: Number of site instances failed to provision.
failedInstancesLogs:
type: array
description: List of URLs pointing to logs for instances which failed to provision.
items:
type: string
errors:
type: array
description: List of errors.
items:
$ref: '#/definitions/ErrorEntity'
x-ms-identifiers: []
ConnectionStringDictionary:
type: object
description: String dictionary resource.
properties:
properties:
type: object
description: Connection strings.
additionalProperties:
$ref: '#/definitions/ConnStringValueTypePair'
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
PerfMonResponse:
type: object
description: Performance monitor API response.
properties:
code:
type: string
description: The response code.
message:
type: string
description: The message.
data:
$ref: '#/definitions/PerfMonSet'
description: The performance monitor counters.
CustomHostnameAnalysisResult:
type: object
description: Custom domain analysis.
properties:
properties:
$ref: '#/definitions/CustomHostnameAnalysisResultProperties'
description: CustomHostnameAnalysisResult resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
BackupRequestProperties:
type: object
description: BackupRequest resource specific properties
properties:
backupName:
type: string
description: Name of the backup.
enabled:
type: boolean
description: True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
storageAccountUrl:
type: string
description: SAS URL to the container.
backupSchedule:
$ref: '#/definitions/BackupSchedule'
description: Schedule for the backup if it is executed periodically.
databases:
type: array
description: Databases included in the backup.
items:
$ref: '#/definitions/DatabaseBackupSetting'
x-ms-identifiers:
- name
required:
- storageAccountUrl
FunctionEnvelopeProperties:
type: object
description: FunctionEnvelope resource specific properties
properties:
function_app_id:
type: string
description: Function App ID.
x-ms-client-name: functionAppId
script_root_path_href:
type: string
description: Script root path URI.
x-ms-client-name: scriptRootPathHref
script_href:
type: string
description: Script URI.
x-ms-client-name: scriptHref
config_href:
type: string
description: Config URI.
x-ms-client-name: configHref
test_data_href:
type: string
description: Test data URI.
x-ms-client-name: testDataHref
secrets_file_href:
type: string
description: Secrets file URI.
x-ms-client-name: secretsFileHref
href:
type: string
description: Function URI.
config:
description: Config information.
files:
type: object
description: File list.
additionalProperties:
type: string
test_data:
type: string
description: Test data used when testing via the Azure Portal.
x-ms-client-name: testData
invoke_url_template:
type: string
description: The invocation URL
x-ms-client-name: invokeUrlTemplate
language:
type: string
description: The function language
isDisabled:
type: boolean
description: Gets or sets a value indicating whether the function is disabled
PerfMonCounterCollection:
type: object
description: Collection of performance monitor counters.
properties:
value:
type: array
description: The PerfMonResponse items on this page
items:
$ref: '#/definitions/PerfMonResponse'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
ContinuousWebJobProperties:
type: object
description: ContinuousWebJob resource specific properties
properties:
status:
$ref: '#/definitions/ContinuousWebJobStatus'
description: Job status.
detailed_status:
type: string
description: Detailed status.
x-ms-client-name: detailedStatus
log_url:
type: string
description: Log URL.
x-ms-client-name: logUrl
run_command:
type: string
description: Run command.
x-ms-client-name: runCommand
url:
type: string
description: Job URL.
extra_info_url:
type: string
description: Extra Info URL.
x-ms-client-name: extraInfoUrl
web_job_type:
$ref: '#/definitions/WebJobType'
description: Job type.
x-ms-client-name: webJobType
error:
type: string
description: Error information.
using_sdk:
type: boolean
description: Using SDK?
x-ms-client-name: usingSdk
settings:
type: object
description: Job settings.
additionalProperties: {}
WebSiteInstanceStatus:
type: object
description: Concrete proxy resource types can be created by aliasing this type using a specific property type.
properties:
properties:
$ref: '#/definitions/WebSiteInstanceStatusProperties'
description: WebSiteInstanceStatus resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
SiteLimits:
type: object
description: Metric limits set on an app.
properties:
maxPercentageCpu:
type: number
format: double
description: Maximum allowed CPU usage percentage.
maxMemoryInMb:
type: integer
format: int64
description: Maximum allowed memory usage in MB.
maxDiskSizeInMb:
type: integer
format: int64
description: Maximum allowed disk size usage in MB.
TriggeredJobHistory:
type: object
description: Triggered Web Job History. List of Triggered Web Job Run Information elements.
properties:
properties:
$ref: '#/definitions/TriggeredJobHistoryProperties'
description: TriggeredJobHistory resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
ContainerThrottlingData:
type: object
properties:
periods:
type: integer
format: int32
throttledPeriods:
type: integer
format: int32
throttledTime:
type: integer
format: int32
FunctionsSiteUpdateStrategy:
type: object
description: Function app site update strategy configuration for deployments and site config updates.
properties:
type:
$ref: '#/definitions/SiteUpdateStrategyType'
description: 'Function app site update strategy type. Available options: Recreate, RollingUpdate'
ProcessModuleInfoProperties:
type: object
description: ProcessModuleInfo resource specific properties
properties:
base_address:
type: string
description: Base address. Used as module identifier in ARM resource URI.
x-ms-client-name: baseAddress
file_name:
type: string
description: File name.
x-ms-client-name: fileName
href:
type: string
description: HRef URI.
file_path:
type: string
description: File path.
x-ms-client-name: filePath
module_memory_size:
type: integer
format: int32
description: Module memory size.
x-ms-client-name: moduleMemorySize
file_version:
type: string
description: File version.
x-ms-client-name: fileVersion
file_description:
type: string
description: File description.
x-ms-client-name: fileDescription
product:
type: string
description: Product name.
product_version:
type: string
description: Product version.
x-ms-client-name: productVersion
is_debug:
type: boolean
description: Is debug?
x-ms-client-name: isDebug
language:
type: string
description: Module language (locale).
GlobalValidation:
type: object
description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization.
properties:
requireAuthentication:
type: boolean
description: true if the authentication flow is required any request is made; otherwise, false.
unauthenticatedClientAction:
$ref: '#/definitions/UnauthenticatedClientActionV2'
description: The action to take when an unauthenticated client attempts to access the app.
redirectToProvider:
type: string
description: 'The default authentication provider to use when multiple providers are configured.
This setting is only needed if multiple providers are configured and the unauthenticated client
action is set to "RedirectToLoginPage".'
excludedPaths:
type: array
description: The paths for which unauthenticated flow would not be redirected to the login page.
items:
type: string
TriggeredWebJobStatus:
type: string
description: Job status.
enum:
- Success
- Failed
- Error
x-ms-enum:
name: TriggeredWebJobStatus
modelAsString: false
WorkflowHealth:
type: object
description: Represents the workflow health.
properties:
state:
$ref: '#/definitions/WorkflowHealthState'
description: Gets or sets the workflow health state.
error:
$ref: '#/definitions/ErrorEntity'
description: Gets or sets the workflow error.
required:
- state
StatusCodesRangeBasedTrigger:
type: object
description: Trigger based on range of status codes.
properties:
statusCodes:
type: string
description: HTTP status code.
path:
type: string
count:
type: integer
format: int32
description: Request Count.
timeInterval:
type: string
description: Time interval.
StringDictionary:
type: object
description: String dictionary resource.
properties:
properties:
type: object
description: Settings.
additionalProperties:
type: string
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
AzureTableStorageApplicationLogsConfig:
type: object
description: Application logs to Azure table storage configuration.
properties:
level:
$ref: '#/definitions/LogLevel'
description: Log level.
sasUrl:
type: string
description: SAS URL to an Azure table with add/query/delete permissions.
required:
- sasUrl
GitHubActionCodeConfiguration:
type: object
description: The GitHub action code configuration.
properties:
runtimeStack:
type: string
description: Runtime stack is used to determine the workflow file content for code base apps.
runtimeVersion:
type: string
description: Runtime version is used to determine what build version to set in the workflow file.
UserAssignedIdentity:
type: object
description: User Assigned identity.
properties:
principalId:
type: string
description: Principal Id of user assigned identity
readOnly: true
clientId:
type: string
description: Client Id of user assigned identity
readOnly: true
ProcessModuleInfo:
type: object
description: Process Module Information.
properties:
properties:
$ref: '#/definitions/ProcessModuleInfoProperties'
description: ProcessModuleInfo resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
SnapshotRecoverySource:
type: object
description: Specifies the web app that snapshot contents will be retrieved from.
properties:
location:
type: string
description: Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS
id:
type: string
description: 'ARM resource ID of the source app.
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.'
SlotConfigNames:
type: object
description: 'Names for connection strings, application settings, and external Azure storage account configuration
identifiers to be marked as sticky to the deployment slot and not moved during a swap operation.
This is valid for all deployment slots in an app.'
properties:
connectionStringNames:
type: array
description: List of connection string names.
items:
type: string
appSettingNames:
type: array
description: List of application settings names.
items:
type: string
azureStorageConfigNames:
type: array
description: List of external Azure storage account identifiers.
items:
type: string
AllowedAudiencesValidation:
type: object
description: The configuration settings of the Allowed Audiences validation flow.
properties:
allowedAudiences:
type: array
description: The configuration settings of the allowed list of audiences from which to validate the JWT token.
items:
type: string
FileSystemHttpLogsConfig:
type: object
description: Http logs to file system configuration.
properties:
retentionInMb:
type: integer
format: int32
description: 'Maximum size in megabytes that http log files can use.
When reached old log files will be removed to make space for new ones.
Value can range between 25 and 100.'
minimum: 25
maximum: 100
retentionInDays:
type: integer
format: int32
description: 'Retention in days.
Remove files older than X days.
0 or lower means no retention.'
enabled:
type: boolean
description: True if configuration is enabled, false if it is disabled and null if configuration is not set.
DeletedAppRestoreRequest:
type: object
description: Details about restoring a deleted app.
properties:
properties:
$ref: '#/definitions/DeletedAppRestoreRequestProperties'
description: DeletedAppRestoreRequest resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
UsageState:
type: string
description: State indicating whether the app has exceeded its quota usage. Read-only.
enum:
- Normal
- Exceeded
x-ms-enum:
name: UsageState
modelAsString: false
IdentityProviders:
type: object
description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization.
properties:
azureActiveDirectory:
$ref: '#/definitions/AzureActiveDirectory'
description: The configuration settings of the Azure Active directory provider.
facebook:
$ref: '#/definitions/Facebook'
description: The configuration settings of the Facebook provider.
gitHub:
$ref: '#/definitions/GitHub'
description: The configuration settings of the GitHub provider.
google:
$ref: '#/definitions/Google'
description: The configuration settings of the Google provider.
legacyMicrosoftAccount:
$ref: '#/definitions/LegacyMicrosoftAccount'
description: The configuration settings of the legacy Microsoft Account provider.
twitter:
$ref: '#/definitions/Twitter'
description: The configuration settings of the Twitter provider.
apple:
$ref: '#/definitions/Apple'
description: The configuration settings of the Apple provider.
azureStaticWebApps:
$ref: '#/definitions/AzureStaticWebApps'
description: The configuration settings of the Azure Static Web Apps provider.
customOpenIdConnectProviders:
type: object
description: 'The map of the name of the alias of each custom Open ID Connect provider to the
configuration settings of the custom Open ID Connect provider.'
additionalProperties:
$ref: '#/definitions/CustomOpenIdConnectProvider'
AzureStaticWebAppsRegistration:
type: object
description: The configuration settings of the registration for the Azure Static Web Apps provider
properties:
clientId:
type: string
description: The Client ID of the app used for login.
ArmIdWrapper:
type: object
description: A wrapper for an ARM resource id
properties:
id:
type: string
readOnly: true
SnapshotRestoreRequestProperties:
type: object
description: SnapshotRestoreRequest resource specific properties
properties:
snapshotTime:
type: string
description: Point in time in which the app restore should be done, formatted as a DateTime string.
recoverySource:
$ref: '#/definitions/SnapshotRecoverySource'
description: 'Optional. Specifies the web app that snapshot contents will be retrieved from.
If empty, the targeted web app will be used as the source.'
overwrite:
type: boolean
description: If true the restore operation can overwrite source app; otherwise, false.
recoverConfiguration:
type: boolean
description: If true, site configuration, in addition to content, will be reverted.
ignoreConflictingHostNames:
type: boolean
description: 'If true, custom hostname conflicts will be ignored when recovering to a target web app.
This setting is only necessary when RecoverConfiguration is enabled.'
useDRSecondary:
type: boolean
description: If true, the snapshot is retrieved from DRSecondary endpoint.
required:
- overwrite
FunctionsDeploymentStorageAuthentication:
type: object
description: Authentication method to access the storage account for deployment.
properties:
type:
$ref: '#/definitions/AuthenticationType'
description: 'Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.'
userAssignedIdentityResourceId:
type: string
description: Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type.
storageAccountConnectionStringName:
type: string
description: Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type.
SiteLogsConfig:
type: object
description: Configuration of App Service site logs.
properties:
properties:
$ref: '#/definitions/SiteLogsConfigProperties'
description: SiteLogsConfig resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
Operation:
type: object
description: An operation on a resource.
properties:
id:
type: string
description: Operation ID.
name:
type: string
description: Operation name.
status:
$ref: '#/definitions/OperationStatus'
description: The current status of the operation.
errors:
type: array
description: Any errors associate with the operation.
items:
$ref: '#/definitions/ErrorEntity'
x-ms-identifiers: []
createdTime:
type: string
format: date-time
description: Time when operation has started.
modifiedTime:
type: string
format: date-time
description: Time when operation has been updated.
expirationTime:
type: string
format: date-time
description: Time when operation will expire.
geoMasterOperationId:
type: string
format: uuid
description: Applicable only for stamp operation ids.
DnsVerificationTestResult:
type: string
description: DNS verification test result.
enum:
- Passed
- Failed
- Skipped
x-ms-enum:
name: DnsVerificationTestResult
modelAsString: false
FunctionsAlwaysReadyConfig:
type: object
description: Sets the number of 'Always Ready' instances for a function group or a specific function.
properties:
name:
type: string
description: Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready.
instanceCount:
type: integer
format: int32
description: Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready.
ConnectionStringType:
type: string
description: Type of database.
enum:
- MySql
- SQLServer
- SQLAzure
- Custom
- NotificationHub
- ServiceBus
- EventHub
- ApiHub
- DocDb
- RedisCache
- PostgreSQL
x-ms-enum:
name: ConnectionStringType
modelAsString: false
CsmPublishingProfileOptions:
type: object
description: Publishing options for requested profile.
properties:
format:
$ref: '#/definitions/PublishingProfileFormat'
description: 'Name of the format. Valid values are:
FileZilla3
WebDeploy -- default
Ftp'
includeDisasterRecoveryEndpoints:
type: boolean
description: Include the DisasterRecover endpoint if true
SwiftVirtualNetworkProperties:
type: object
description: SwiftVirtualNetwork resource specific properties
properties:
subnetResourceId:
type: string
description: The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.
swiftSupported:
type: boolean
description: A flag that specifies if the scale unit this Web App is on supports Swift integration.
AzureActiveDirectory:
type: object
description: The configuration settings of the Azure Active directory provider.
properties:
enabled:
type: boolean
description: false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true.
registration:
$ref: '#/definitions/AzureActiveDirectoryRegistration'
description: The configuration settings of the Azure Active Directory app registration.
login:
$ref: '#/definitions/AzureActiveDirectoryLogin'
description: The configuration settings of the Azure Active Directory login flow.
validation:
$ref: '#/definitions/AzureActiveDirectoryValidation'
description: The configuration settings of the Azure Active Directory token validation flow.
isAutoProvisioned:
type: boolean
description: 'Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.
This is an internal flag primarily intended to support the Azure Management Portal. Users should not
read or write to this property.'
ResolveStatus:
type: string
enum:
- Initialized
- Resolved
- InvalidSyntax
- MSINotEnabled
- VaultNotFound
- SecretNotFound
- SecretVersionNotFound
- AccessToKeyVaultDenied
- OtherReasons
- FetchTimedOut
- UnauthorizedClient
x-ms-enum:
name: ResolveStatus
modelAsString: false
ContainerCpuUsage:
type: object
properties:
totalUsage:
type: integer
format: int64
perCpuUsage:
type: array
items:
type: integer
format: int64
kernelModeUsage:
type: integer
format: int64
userModeUsage:
type: integer
format: int64
PrivateLinkResource:
type: object
description: A private link resource
properties:
id:
type: string
name:
type: string
description: Name of a private link resource
type:
type: string
properties:
$ref: '#/definitions/PrivateLinkResourceProperties'
description: Properties of a private link resource
required:
- id
- name
- type
- properties
Nonce:
type: object
description: The configuration settings of the nonce used in the login flow.
properties:
validateNonce:
type: boolean
description: false if the nonce should not be validated while completing the login flow; otherwise, true.
nonceExpirationInterval:
type: string
description: The time after the request is made when the nonce should expire.
SiteConfigResourceCollection:
type: object
description: Collection of site configurations.
properties:
value:
type: array
description: The SiteConfigResource items on this page
items:
$ref: '#/definitions/SiteConfigResource'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
SiteConfigResource:
type: object
description: Web app configuration ARM resource.
properties:
properties:
$ref: '#/definitions/SiteConfig'
description: Core resource properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
EnabledConfig:
type: object
description: Enabled configuration.
properties:
enabled:
type: boolean
description: True if configuration is enabled, false if it is disabled and null if configuration is not set.
SlotSwapStatus:
type: object
description: The status of the last successful slot swap operation.
properties:
timestampUtc:
type: string
format: date-time
description: The time the last successful slot swap completed.
readOnly: true
sourceSlotName:
type: string
description: The source slot of the last swap operation.
readOnly: true
destinationSlotName:
type: string
description: The destination slot of the last swap operation.
readOnly: true
PrivateLinkConnectionState:
type: object
description: The state of a private link connection
properties:
status:
type: string
description: Status of a private link connection
description:
type: string
description: Description of a private link connection
actionsRequired:
type: string
description: ActionsRequired for a private link connection
RelayServiceConnectionEntity:
type: object
description: Hybrid Connection for an App Service app.
properties:
properties:
$ref: '#/definitions/RelayServiceConnectionEntityProperties'
description: RelayServiceConnectionEntity resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
ContinuousWebJobStatus:
type: string
description: Job status.
enum:
- Initializing
- Starting
- Running
- PendingRestart
- Stopped
x-ms-enum:
name: ContinuousWebJobStatus
modelAsString: false
ProcessThreadInfoCollection:
type: object
description: Collection of Kudu thread information elements.
properties:
value:
type: array
description: The ProcessThreadInfo items on this page
items:
$ref: '#/definitions/ProcessThreadInfo'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
AllowedPrincipals:
type: object
description: The configuration settings of the Azure Active Directory allowed principals.
properties:
groups:
type: array
description: The list of the allowed groups.
items:
type: string
identities:
type: array
description: The list of the allowed identities.
items:
type: string
SlowRequestsBasedTrigger:
type: object
description: Trigger based on request execution time.
properties:
timeTaken:
type: string
description: Time taken.
path:
type: string
description: Request Path.
count:
type: integer
format: int32
description: Request Count.
timeInterval:
type: string
description: Time interval.
WebSiteInstanceStatusProperties:
type: object
description: WebSiteInstanceStatus resource specific properties
properties:
state:
$ref: '#/definitions/SiteRuntimeState'
statusUrl:
type: string
description: Link to the GetStatusApi in Kudu
detectorUrl:
type: string
description: Link to the Diagnose and Solve Portal
consoleUrl:
type: string
description: Link to the console to web app instance
healthCheckUrl:
type: string
description: Link to the console to web app instance
containers:
type: object
description: Dictionary of
additionalProperties:
$ref: '#/definitions/ContainerInfo'
physicalZone:
type: string
description: The physical zone that the instance is in
WebJobType:
type: string
description: Job type.
enum:
- Continuous
- Triggered
x-ms-enum:
name: WebJobType
modelAsString: false
MSDeployStatus:
type: object
description: MSDeploy ARM response
properties:
properties:
$ref: '#/definitions/MSDeployStatusProperties'
description: MSDeployStatus resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
BackupRequest:
type: object
description: Description of a backup which will be performed.
properties:
properties:
$ref: '#/definitions/BackupRequestProperties'
description: BackupRequest resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
AutoHealRules:
type: object
description: Rules that can be defined for auto-heal.
properties:
triggers:
$ref: '#/definitions/AutoHealTriggers'
description: Conditions that describe when to execute the auto-heal actions.
actions:
$ref: '#/definitions/AutoHealActions'
description: Actions to be executed when a rule is triggered.
PremierAddOnProperties:
type: object
description: PremierAddOn resource specific properties
properties:
sku:
type: string
description: Premier add on SKU.
product:
type: string
description: Premier add on Product.
vendor:
type: string
description: Premier add on Vendor.
marketplacePublisher:
type: string
description: Premier add on Marketplace publisher.
marketplaceOffer:
type: string
description: Premier add on Marketplace offer.
AuthenticationType:
type: string
description: 'Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.'
enum:
- SystemAssignedIdentity
- UserAssignedIdentity
- StorageAccountConnectionString
x-ms-enum:
name: AuthenticationType
modelAsString: true
values:
- name: SystemAssignedIdentity
value: SystemAssignedIdentity
- name: UserAssignedIdentity
value: UserAssignedIdentity
- name: StorageAccountConnectionString
value: StorageAccountConnectionString
BlobStorageTokenStore:
type: object
description: The configuration settings of the storage of the tokens if blob storage is used.
properties:
sasUrlSettingName:
type: string
description: The name of the app setting containing the SAS URL of the blob storage containing the tokens.
CustomHostnameAnalysisResultProperties:
type: object
description: CustomHostnameAnalysisResult resource specific properties
properties:
isHostnameAlreadyVerified:
type: boolean
description: true if hostname is already verified; otherwise, false.
readOnly: true
customDomainVerificationTest:
$ref: '#/definitions/DnsVerificationTestResult'
description: DNS verification test result.
readOnly: true
customDomainVerificationFailureInfo:
$ref: '#/definitions/ErrorEntity'
description: Raw failure information if DNS verification fails.
readOnly: true
hasConflictOnScaleUnit:
type: boolean
description: true if there is a conflict on a scale unit; otherwise, false.
readOnly: true
hasConflictAcrossSubscription:
type: boolean
description: true if there is a conflict across subscriptions; otherwise, false.
readOnly: true
conflictingAppResourceId:
type: string
description: Name of the conflicting app on scale unit if it's within the same subscription.
readOnly: true
cNameRecords:
type: array
description: CName records controller can see for this hostname.
items:
type: string
txtRecords:
type: array
description: TXT records controller can see for this hostname.
items:
type: string
aRecords:
type: array
description: A records controller can see for this hostname.
items:
type: string
alternateCNameRecords:
type: array
description: Alternate CName records controller can see for this hostname.
items:
type: string
alternateTxtRecords:
type: array
description: Alternate TXT records controller can see for this hostname.
items:
type: string
SiteExtensionInfo:
type: object
description: Site Extension Information.
properties:
properties:
$ref: '#/definitions/SiteExtensionInfoProperties'
description: SiteExtensionInfo resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
DeploymentProperties:
type: object
description: Deployment resource specific properties
properties:
status:
type: integer
format: int32
description: Deployment status.
message:
type: string
description: Details about deployment status.
author:
type: string
description: Who authored the deployment.
deployer:
type: string
description: Who performed the deployment.
author_email:
type: string
description: Author email.
x-ms-client-name: authorEmail
start_time:
type: string
format: date-time
description: Start time.
x-ms-client-name: startTime
end_time:
type: string
format: date-time
description: End time.
x-ms-client-name: endTime
active:
type: boolean
description: True if deployment is currently active, false if completed and null if not started.
details:
type: string
description: Details on deployment.
VirtualDirectory:
type: object
description: Directory for virtual application.
properties:
virtualPath:
type: string
description: Path to virtual application.
physicalPath:
type: string
description: Physical path.
DefaultAction:
type: string
description: Default action for main access restriction if no rules are matched.
enum:
- Allow
- Deny
x-ms-enum:
name: DefaultAction
modelAsString: true
values:
- name: Allow
value: Allow
- name: Deny
value: Deny
SiteAuthSettings:
type: object
description: Configuration settings for the Azure App Service Authentication / Authorization feature.
properties:
properties:
$ref: '#/definitions/SiteAuthSettingsProperties'
description: SiteAuthSettings resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
IdentifierCollection:
type: object
description: Collection of identifiers.
properties:
value:
type: array
description: The Identifier items on this page
items:
$ref: '#/definitions/Identifier'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
Google:
type: object
description: The configuration settings of the Google provider.
properties:
enabled:
type: boolean
description: false if the Google provider should not be enabled despite the set registration; otherwise, true.
registration:
$ref: '#/definitions/ClientRegistration'
description: The configuration settings of the app registration for the Google provider.
login:
$ref: '#/definitions/LoginScopes'
description: The configuration settings of the login flow.
validation:
$ref: '#/definitions/AllowedAudiencesValidation'
description: The configuration settings of the Azure Active Directory token validation flow.
PrivateAccessProperties:
type: object
description: PrivateAccess resource specific properties
properties:
enabled:
type: boolean
description: Whether private access is enabled or not.
virtualNetworks:
type: array
description: The Virtual Networks (and subnets) allowed to access the site privately.
items:
$ref: '#/definitions/PrivateAccessVirtualNetwork'
x-ms-identifiers:
- key
SiteContainer:
type: object
description: Container of a site
properties:
properties:
$ref: '#/definitions/SiteContainerProperties'
description: SiteContainer resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
CloneAbilityResult:
type: string
description: Name of app.
enum:
- Cloneable
- PartiallyCloneable
- NotCloneable
x-ms-enum:
name: CloneAbilityResult
modelAsString: false
AzureResourceType:
type: string
description: Azure resource type.
enum:
- Website
- TrafficManager
x-ms-enum:
name: AzureResourceType
modelAsString: false
DefaultErrorResponse:
type: object
description: App Service error response.
properties:
error:
$ref: '#/definitions/DefaultErrorResponseError'
description: Error model.
readOnly: true
SiteAvailabilityState:
type: string
description: Management information availability state for the app.
enum:
- Normal
- Limited
- DisasterRecoveryMode
x-ms-enum:
name: SiteAvailabilityState
modelAsString: false
DefaultErrorResponseErrorDetailsItem:
type: object
description: Detailed errors.
properties:
code:
type: string
description: Standardized string to programmatically identify the error.
readOnly: true
message:
type: string
description: Detailed error description and debugging information.
readOnly: true
target:
type: string
description: Detailed error description and debugging information.
readOnly: true
HttpSettingsRoutes:
type: object
description: The configuration settings of the paths HTTP requests.
properties:
apiPrefix:
type: string
description: The prefix that should precede all the authentication/authorization paths.
NameValuePair:
type: object
description: Name value pair.
properties:
name:
type: string
description: Pair name.
value:
type: string
description: Pair value.
CustomOpenIdConnectProvider:
type: object
description: The configuration settings of the custom Open ID Connect provider.
properties:
enabled:
type: boolean
description: false if the custom Open ID provider provider should not be enabled; otherwise, true.
registration:
$ref: '#/definitions/OpenIdConnectRegistration'
description: The configuration settings of the app registration for the custom Open ID Connect provider.
login:
$ref: '#/definitions/OpenIdConnectLogin'
description: The configuration settings of the login flow of the custom Open ID Connect provider.
MSDeployLogEntryType:
type: string
description: Log entry type
enum:
- Message
- Warning
- Error
x-ms-enum:
name: MSDeployLogEntryType
modelAsString: false
SiteConfigurationSnapshotInfoProperties:
type: object
description: SiteConfigurationSnapshotInfo resource specific properties
properties:
time:
type: string
format: date-time
description: The time the snapshot was taken.
readOnly: true
snapshotId:
type: integer
format: int32
description: The id of the snapshot
readOnly: true
Login:
type: object
description: The configuration settings of the login flow of users using App Service Authentication/Authorization.
properties:
routes:
$ref: '#/definitions/LoginRoutes'
description: The routes that specify the endpoints used for login and logout requests.
tokenStore:
$ref: '#/definitions/TokenStore'
description: The configuration settings of the token store.
preserveUrlFragmentsForLogins:
type: boolean
description: true if the fragments from the request are preserved after the login request is made; otherwise, false.
allowedExternalRedirectUrls:
type: array
description: 'External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.
This is an advanced setting typically only needed by Windows Store application backends.
Note that URLs within the current domain are always implicitly allowed.'
items:
type: string
cookieExpiration:
$ref: '#/definitions/CookieExpiration'
description: The configuration settings of the session cookie's expiration.
nonce:
$ref: '#/definitions/Nonce'
description: The configuration settings of the nonce used in the login flow.
ClientCertMode:
type: string
description: 'This composes with ClientCertEnabled setting.
- ClientCertEnabled: false means ClientCert is ignored.
- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.'
enum:
- Required
- Optional
- OptionalInteractiveUser
x-ms-enum:
name: ClientCertMode
modelAsString: false
ManagedServiceIdentity:
type: object
description: Managed service identity.
properties:
type:
$ref: '#/definitions/ManagedServiceIdentityType'
description: Type of managed service identity.
tenantId:
type: string
description: Tenant of managed service identity.
readOnly: true
principalId:
type: string
description: Principal Id of managed service identity.
readOnly: true
userAssignedIdentities:
type: object
description: 'The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'
additionalProperties:
$ref: '#/definitions/UserAssignedIdentity'
FunctionSecrets:
type: object
description: Function secrets.
properties:
key:
type: string
description: Secret key.
trigger_url:
type: string
description: Trigger URL.
x-ms-client-name: triggerUrl
CsmUsageQuota:
type: object
description: Usage of the quota resource.
properties:
unit:
type: string
description: Units of measurement for the quota resource.
nextResetTime:
type: string
format: date-time
description: Next reset time for the resource counter.
currentValue:
type: integer
format: int64
description: The current value of the resource counter.
limit:
type: integer
format: int64
description: The resource limit.
name:
$ref: '#/definitions/LocalizableString'
description: Quota name.
PublicCertificateProperties:
type: object
description: PublicCertificate resource specific properties
properties:
blob:
type: string
format: byte
description: Public Certificate byte array
publicCertificateLocation:
$ref: '#/definitions/PublicCertificateLocation'
description: Public Certificate Location
thumbprint:
type: string
description: Certificate Thumbprint
readOnly: true
RouteType:
type: string
description: 'The type of route this is:
DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918
INHERITED - Routes inherited from the real Virtual Network routes
STATIC - Static route set on the app only
These values will be used for syncing an app''s routes with those from a Virtual Network.'
enum:
- DEFAULT
- INHERITED
- STATIC
x-ms-enum:
name: RouteType
modelAsString: true
values:
- name: DEFAULT
value: DEFAULT
- name: INHERITED
value: INHERITED
- name: STATIC
value: STATIC
HybridConnection:
type: object
description: Hybrid Connection contract. This is used to configure a Hybrid Connection.
properties:
properties:
$ref: '#/definitions/HybridConnectionProperties'
description: HybridConnection resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
User:
type: object
description: User credentials used for publishing activity.
properties:
properties:
$ref: '#/definitions/UserProperties'
description: User resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
ApiKVReferenceCollection:
type: object
description: Paged collection of ApiKVReference items
properties:
value:
type: array
description: The ApiKVReference items on this page
items:
$ref: '#/definitions/ApiKVReference'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
ExtendedLocation:
type: object
description: Extended Location.
properties:
name:
type: string
description: Name of extended location.
type:
type: string
description: Type of extended location.
readOnly: true
SiteAuthSettingsV2:
type: object
description: Configuration settings for the Azure App Service Authentication / Authorization V2 feature.
properties:
properties:
$ref: '#/definitions/SiteAuthSettingsV2Properties'
description: SiteAuthSettingsV2 resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
SwiftVirtualNetwork:
type: object
description: Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.
properties:
properties:
$ref: '#/definitions/SwiftVirtualNetworkProperties'
description: SwiftVirtualNetwork resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
FunctionsScaleAndConcurrency:
type: object
description: Scale and concurrency settings for the function app.
properties:
alwaysReady:
type: array
description: '''Always Ready'' configuration for the function app.'
items:
$ref: '#/definitions/FunctionsAlwaysReadyConfig'
maximumInstanceCount:
type: integer
format: int32
description: The maximum number of instances for the function app.
instanceMemoryMB:
type: integer
format: int32
description: Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally.
triggers:
$ref: '#/definitions/FunctionsScaleAndConcurrencyTriggers'
description: Scale and concurrency settings for the function app triggers.
HostNameBinding:
type: object
description: A hostname binding object.
properties:
properties:
$ref: '#/definitions/HostNameBindingProperties'
description: HostNameBinding resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
SitePhpErrorLogFlagProperties:
type: object
description: SitePhpErrorLogFlag resource specific properties
properties:
localLogErrors:
type: string
description: Local log_errors setting.
masterLogErrors:
type: string
description: Master log_errors setting.
localLogErrorsMaxLength:
type: string
description: Local log_errors_max_len setting.
masterLogErrorsMaxLength:
type: string
description: Master log_errors_max_len setting.
AuthPlatform:
type: object
description: The configuration settings of the platform of App Service Authentication/Authorization.
properties:
enabled:
type: boolean
description: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
runtimeVersion:
type: string
description: 'The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
The setting in this value can control the behavior of certain features in the Authentication / Authorization module.'
configFilePath:
type: string
description: 'The path of the config file containing auth settings if they come from a file.
If the path is relative, base will the site''s root directory.'
PublicCertificate:
type: object
description: Public certificate object
properties:
properties:
$ref: '#/definitions/PublicCertificateProperties'
description: PublicCertificate resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
NetworkFeatures:
type: object
description: Full view of network features for an app (presently VNET integration and Hybrid Connections).
properties:
properties:
$ref: '#/definitions/NetworkFeaturesProperties'
description: NetworkFeatures resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
PrivateLinkResourcesWrapper:
type: object
description: Wrapper for a collection of private link resources
properties:
value:
type: array
items:
$ref: '#/definitions/PrivateLinkResource'
required:
- value
EnvironmentVariable:
type: object
properties:
name:
type: string
description: Environment variable name
value:
type: string
description: The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime.
required:
- name
- value
BackupItemCollection:
type: object
description: Collection of backup items.
properties:
value:
type: array
description: The BackupItem items on this page
items:
$ref: '#/definitions/BackupItem'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
HostingEnvironmentProfile:
type: object
description: Specification for an App Service Environment to use for this resource.
properties:
id:
type: string
description: Resource ID of the App Service Environment.
name:
type: string
description: Name of the App Service Environment.
readOnly: true
type:
type: string
description: Resource type of the App Service Environment.
readOnly: true
FunctionEnvelope:
type: object
description: Function information.
properties:
properties:
$ref: '#/definitions/FunctionEnvelopeProperties'
description: FunctionEnvelope resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
RelayServiceConnectionEntityProperties:
type: object
description: RelayServiceConnectionEntity resource specific properties
properties:
entityName:
type: string
entityConnectionString:
type: string
resourceType:
type: string
resourceConnectionString:
type: string
hostname:
type: string
port:
type: integer
format: int32
biztalkUri:
type: string
LegacyMicrosoftAccount:
type: object
description: The configuration settings of the legacy Microsoft Account provider.
properties:
enabled:
type: boolean
description: false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true.
registration:
$ref: '#/definitions/ClientRegistration'
description: The configuration settings of the app registration for the legacy Microsoft Account provider.
login:
$ref: '#/definitions/LoginScopes'
description: The configuration settings of the login flow.
validation:
$ref: '#/definitions/AllowedAudiencesValidation'
description: The configuration settings of the legacy Microsoft Account provider token validation flow.
TriggeredWebJob:
type: object
description: Triggered Web Job Information.
properties:
properties:
$ref: '#/definitions/TriggeredWebJobProperties'
description: TriggeredWebJob resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
PerfMonSet:
type: object
description: Metric information.
properties:
name:
type: string
description: Unique key name of the counter.
startTime:
type: string
format: date-time
description: Start time of the period.
endTime:
type: string
format: date-time
description: End time of the period.
timeGrain:
type: string
description: Presented time grain.
values:
type: array
description: Collection of workers that are active during this time.
items:
$ref: '#/definitions/PerfMonSample'
x-ms-identifiers: []
ErrorEntity:
type: object
description: Body of the error response returned from the API.
properties:
extendedCode:
type: string
description: Type of error.
messageTemplate:
type: string
description: Message template.
parameters:
type: array
description: Parameters for the template.
items:
type: string
innerErrors:
type: array
description: Inner errors.
items:
$ref: '#/definitions/ErrorEntity'
x-ms-identifiers: []
details:
type: array
description: Error Details.
items:
$ref: '#/definitions/ErrorEntity'
x-ms-identifiers: []
target:
type: string
description: The error target.
code:
type: string
description: Basic error code.
message:
type: string
description: Any details of the error.
PremierAddOnPatchResourceProperties:
type: object
description: PremierAddOnPatchResource resource specific properties
properties:
sku:
type: string
description: Premier add on SKU.
product:
type: string
description: Premier add on Product.
vendor:
type: string
description: Premier add on Vendor.
marketplacePublisher:
type: string
description: Premier add on Marketplace publisher.
marketplaceOffer:
type: string
description: Premier add on Marketplace offer.
ApiManagementConfig:
type: object
description: Azure API management (APIM) configuration linked to the app.
properties:
id:
type: string
description: APIM-Api Identifier.
TriggeredWebJobCollection:
type: object
description: Collection of Kudu continuous web job information elements.
properties:
value:
type: array
description: The TriggeredWebJob items on this page
items:
$ref: '#/definitions/TriggeredWebJob'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
BackupItemProperties:
type: object
description: BackupItem resource specific properties
properties:
id:
type: integer
format: int32
description: Id of the backup.
readOnly: true
x-ms-client-name: BackupId
storageAccountUrl:
type: string
description: SAS URL for the storage account container which contains this backup.
readOnly: true
blobName:
type: string
description: Name of the blob which contains data for this backup.
readOnly: true
name:
type: string
description: Name of this backup.
readOnly: true
status:
$ref: '#/definitions/BackupItemStatus'
description: Backup status.
readOnly: true
sizeInBytes:
type: integer
format: int64
description: Size of the backup in bytes.
readOnly: true
created:
type: string
format: date-time
description: Timestamp of the backup creation.
readOnly: true
log:
type: string
description: Details regarding this backup. Might contain an error message.
readOnly: true
databases:
type: array
description: List of databases included in the backup.
items:
$ref: '#/definitions/DatabaseBackupSetting'
readOnly: true
x-ms-identifiers:
- name
scheduled:
type: boolean
description: True if this backup has been created due to a schedule being triggered.
readOnly: true
lastRestoreTimeStamp:
type: string
format: date-time
description: Timestamp of a last restore operation which used this backup.
readOnly: true
finishedTimeStamp:
type: string
format: date-time
description: Timestamp when this backup finished.
readOnly: true
correlationId:
type: string
description: Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
readOnly: true
websiteSizeInBytes:
type: integer
format: int64
description: Size of the original web app which has been backed up.
readOnly: true
SiteRuntimeState:
type: string
enum:
- READY
- STOPPED
- UNKNOWN
x-ms-enum:
name: SiteRuntimeState
modelAsString: false
HostNameType:
type: string
description: Hostname type.
enum:
- Verified
- Managed
x-ms-enum:
name: HostNameType
modelAsString: false
SiteSourceControl:
type: object
description: Source control configuration for an app.
properties:
properties:
$ref: '#/definitions/SiteSourceControlProperties'
description: SiteSourceControl resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
JwtClaimChecks:
type: object
description: The configuration settings of the checks that should be made while validating the JWT Claims.
properties:
allowedGroups:
type: array
description: The list of the allowed groups.
items:
type: string
allowedClientApplications:
type: array
description: The list of the allowed client applications.
items:
type: string
WebJob:
type: object
description: Web Job Information.
properties:
properties:
$ref: '#/definitions/WebJobProperties'
description: WebJob resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
PushSettings:
type: object
description: Push settings for the App.
properties:
properties:
$ref: '#/definitions/PushSettingsProperties'
description: PushSettings resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
PushSettingsProperties:
type: object
description: PushSettings resource specific properties
properties:
isPushEnabled:
type: boolean
description: Gets or sets a flag indicating whether the Push endpoint is enabled.
tagWhitelistJson:
type: string
description: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
tagsRequiringAuth:
type: string
description: "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."
dynamicTagsJson:
type: string
description: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
required:
- isPushEnabled
MSDeployLogProperties:
type: object
description: MSDeployLog resource specific properties
properties:
entries:
type: array
description: List of log entry messages
items:
$ref: '#/definitions/MSDeployLogEntry'
readOnly: true
x-ms-identifiers: []
MigrateMySqlStatusProperties:
type: object
description: MigrateMySqlStatus resource specific properties
properties:
migrationOperationStatus:
$ref: '#/definitions/OperationStatus'
description: Status of the migration task.
readOnly: true
operationId:
type: string
description: Operation ID for the migration task.
readOnly: true
localMySqlEnabled:
type: boolean
description: True if the web app has in app MySql enabled
readOnly: true
ContainerCpuStatistics:
type: object
properties:
cpuUsage:
$ref: '#/definitions/ContainerCpuUsage'
systemCpuUsage:
type: integer
format: int64
onlineCpuCount:
type: integer
format: int32
throttlingData:
$ref: '#/definitions/ContainerThrottlingData'
MSDeploy:
type: object
description: MSDeploy ARM PUT information
properties:
properties:
$ref: '#/definitions/MSDeployProperties'
description: Core resource properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
ManagedServiceIdentityType:
type: string
description: Type of managed service identity.
enum:
- SystemAssigned
- UserAssigned
- SystemAssigned, UserAssigned
- None
x-ms-enum:
name: ManagedServiceIdentityType
modelAsString: false
FtpsState:
type: string
description: State of FTP / FTPS service
enum:
- AllAllowed
- FtpsOnly
- Disabled
x-ms-enum:
name: FtpsState
modelAsString: true
values:
- name: AllAllowed
value: AllAllowed
- name: FtpsOnly
value: FtpsOnly
- name: Disabled
value: Disabled
TokenStore:
type: object
description: The configuration settings of the token store.
properties:
enabled:
type: boolean
description: 'true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.
The default is false.'
tokenRefreshExtensionHours:
type: number
format: double
description: 'The number of hours after session token expiration that a session token can be used to
call the token refresh API. The default is 72 hours.'
fileSystem:
$ref: '#/definitions/FileSystemTokenStore'
description: The configuration settings of the storage of the tokens if a file system is used.
azureBlobStorage:
$ref: '#/definitions/BlobStorageTokenStore'
description: The configuration settings of the storage of the tokens if blob storage is used.
VnetGatewayProperties:
type: object
description: VnetGateway resource specific properties
properties:
vnetName:
type: string
description: The Virtual Network name.
x-ms-mutability:
- read
- create
vpnPackageUri:
type: string
description: The URI where the VPN package can be downloaded.
x-ms-mutability:
- update
- create
required:
- vpnPackageUri
PrivateEndpointConnectionCollection:
type: object
description: Paged collection of RemotePrivateEndpointConnectionARMResource items
properties:
value:
type: array
description: The RemotePrivateEndpointConnectionARMResource items on this page
items:
$ref: '#/definitions/RemotePrivateEndpointConnectionARMResource'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
HybridConnectionProperties:
type: object
description: HybridConnection resource specific properties
properties:
serviceBusNamespace:
type: string
description: The name of the Service Bus namespace.
x-ms-mutability:
- read
- create
relayName:
type: string
description: The name of the Service Bus relay.
x-ms-mutability:
- read
- create
relayArmUri:
type: string
description: The ARM URI to the Service Bus relay.
hostname:
type: string
description: The hostname of the endpoint.
port:
type: integer
format: int32
description: The port of the endpoint.
sendKeyName:
type: string
description: The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
sendKeyValue:
type: string
description: 'The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned
normally, use the POST /listKeys API instead.'
serviceBusSuffix:
type: string
description: The suffix for the service bus endpoint. By default this is .servicebus.windows.net
BackupItemStatus:
type: string
description: Backup status.
enum:
- InProgress
- Failed
- Succeeded
- TimedOut
- Created
- Skipped
- PartiallySucceeded
- DeleteInProgress
- DeleteFailed
- Deleted
x-ms-enum:
name: BackupItemStatus
modelAsString: false
OperationStatus:
type: string
description: The current status of the operation.
enum:
- InProgress
- Failed
- Succeeded
- TimedOut
- Created
x-ms-enum:
name: OperationStatus
modelAsString: false
Deployment:
type: object
description: User credentials used for publishing activity.
properties:
properties:
$ref: '#/definitions/DeploymentProperties'
description: Deployment resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
AutoHealActions:
type: object
description: Actions which to take by the auto-heal module when a rule is triggered.
properties:
actionType:
$ref: '#/definitions/AutoHealActionType'
description: Predefined action to be taken.
customAction:
$ref: '#/definitions/AutoHealCustomAction'
description: Custom action to be taken.
minProcessExecutionTime:
type: string
description: 'Minimum time the process must execute
before taking the action'
SitePatchResource:
type: object
description: ARM resource for a site.
properties:
properties:
$ref: '#/definitions/SitePatchResourceProperties'
description: SitePatchResource resource specific properties
x-ms-client-flatten: true
identity:
$ref: '#/definitions/ManagedServiceIdentity'
description: Managed service identity.
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
DefaultErrorResponseError:
type: object
description: Error model.
properties:
code:
type: string
description: Standardized string to programmatically identify the error.
readOnly: true
message:
type: string
description: Detailed error description and debugging information.
readOnly: true
target:
type: string
description: Detailed error description and debugging information.
readOnly: true
details:
type: array
items:
$ref: '#/definitions/DefaultErrorResponseErrorDetailsItem'
x-ms-identifiers: []
innererror:
type: string
description: More information to debug error.
readOnly: true
HostNameSslState:
type: object
description: SSL-enabled hostname.
properties:
name:
type: string
description: Hostname.
sslState:
$ref: '#/definitions/SslState'
description: SSL type.
virtualIP:
type: string
description: Virtual IP address assigned to the hostname if IP based SSL is enabled.
thumbprint:
type: string
description: SSL certificate thumbprint.
toUpdate:
type: boolean
description: Set to true to update existing hostname.
hostType:
$ref: '#/definitions/HostType'
description: Indicates whether the hostname is a standard or repository hostname.
CsmPublishingCredentialsPoliciesEntityProperties:
type: object
description: CsmPublishingCredentialsPoliciesEntity resource specific properties
properties:
allow:
type: boolean
description: true to allow access to a publishing method; otherwise, false.
required:
- allow
SiteExtensionInfoProperties:
type: object
description: SiteExtensionInfo resource specific properties
properties:
extension_id:
type: string
description: Site extension ID.
x-ms-client-name: extensionId
title:
type: string
extension_type:
$ref: '#/definitions/SiteExtensionType'
description: Site extension type.
x-ms-client-name: extensionType
summary:
type: string
description: Summary description.
description:
type: string
description: Detailed description.
version:
type: string
description: Version information.
extension_url:
type: string
description: Extension URL.
x-ms-client-name: extensionUrl
project_url:
type: string
description: Project URL.
x-ms-client-name: projectUrl
icon_url:
type: string
description: Icon URL.
x-ms-client-name: iconUrl
license_url:
type: string
description: License URL.
x-ms-client-name: licenseUrl
feed_url:
type: string
description: Feed URL.
x-ms-client-name: feedUrl
authors:
type: array
description: List of authors.
items:
type: string
installer_command_line_params:
type: string
description: Installer command line parameters.
x-ms-client-name: installerCommandLineParams
published_date_time:
type: string
format: date-time
description: Published timestamp.
x-ms-client-name: publishedDateTime
download_count:
type: integer
format: int32
description: Count of downloads.
x-ms-client-name: downloadCount
local_is_latest_version:
type: boolean
description: true if the local version is the latest version; false otherwise.
x-ms-client-name: localIsLatestVersion
local_path:
type: string
description: Local path.
x-ms-client-name: localPath
installed_date_time:
type: string
format: date-time
description: Installed timestamp.
x-ms-client-name: installedDateTime
provisioningState:
type: string
description: Provisioning state.
comment:
type: string
description: Site Extension comment.
LocalizableString:
type: object
description: Localizable string object containing the name and a localized value.
properties:
value:
type: string
description: Non-localized name.
localizedValue:
type: string
description: Localized name.
TriggeredWebJobProperties:
type: object
description: TriggeredWebJob resource specific properties
properties:
latest_run:
$ref: '#/definitions/TriggeredJobRun'
description: Latest job run information.
x-ms-client-name: latestRun
history_url:
type: string
description: History URL.
x-ms-client-name: historyUrl
scheduler_logs_url:
type: string
description: Scheduler Logs URL.
x-ms-client-name: schedulerLogsUrl
run_command:
type: string
description: Run command.
x-ms-client-name: runCommand
url:
type: string
description: Job URL.
extra_info_url:
type: string
description: Extra Info URL.
x-ms-client-name: extraInfoUrl
web_job_type:
$ref: '#/definitions/WebJobType'
description: Job type.
x-ms-client-name: webJobType
error:
type: string
description: Error information.
using_sdk:
type: boolean
description: Using SDK?
x-ms-client-name: usingSdk
publicNetworkAccess:
type: string
description: 'Property to allow or block all public traffic. Allowed Values: ''Enabled'', ''Disabled'' or an empty string.'
storageAccountRequired:
type: boolean
description: Checks if Customer provided storage account is required
settings:
type: object
description: Job settings.
additionalProperties: {}
HostKeys:
type: object
description: Functions host level keys.
properties:
masterKey:
type: string
description: Secret key.
functionKeys:
type: object
description: Host level function keys.
additionalProperties:
type: string
systemKeys:
type: object
description: System keys.
additionalProperties:
type: string
CloningInfo:
type: object
description: Information needed for cloning operation.
properties:
correlationId:
type: string
format: uuid
description: 'Correlation ID of cloning operation. This ID ties multiple cloning operations
together to use the same snapshot.'
overwrite:
type: boolean
description: true to overwrite destination app; otherwise, false.
cloneCustomHostNames:
type: boolean
description: true to clone custom hostnames from source app; otherwise, false.
cloneSourceControl:
type: boolean
description: true to clone source control from source app; otherwise, false.
sourceWebAppId:
type: string
description: 'ARM resource ID of the source app. App resource ID is of the form
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.'
sourceWebAppLocation:
type: string
description: 'Location of source app ex: West US or North Europe'
hostingEnvironment:
type: string
description: App Service Environment.
appSettingsOverrides:
type: object
description: 'Application setting overrides for cloned app. If specified, these settings override the settings cloned
from source app. Otherwise, application settings from source app are retained.'
additionalProperties:
type: string
configureLoadBalancing:
type: boolean
description: true to configure load balancing for source and destination app.
trafficManagerProfileId:
type: string
description: 'ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.'
trafficManagerProfileName:
type: string
description: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.
required:
- sourceWebAppId
SiteUpdateStrategyType:
type: string
description: 'Function app site update strategy type. Available options: Recreate, RollingUpdate'
enum:
- Recreate
- RollingUpdate
x-ms-enum:
name: SiteUpdateStrategyType
modelAsString: true
values:
- name: Recreate
value: Recreate
description: 'If the app is under load and a deployment or site state update occurs, all pods will be removed
and will need to be Recreated all at once. This is the default behavior.'
- name: RollingUpdate
value: RollingUpdate
description: 'If the app is under load and a deployment or site state update occurs, pods will be drained in
batches and gradually replaced, thus minimizing impact to throughput.'
TriggeredJobRun:
type: object
description: Triggered Web Job Run Information.
properties:
web_job_id:
type: string
description: Job ID.
x-ms-client-name: webJobId
web_job_name:
type: string
description: Job name.
x-ms-client-name: webJobName
status:
$ref: '#/definitions/TriggeredWebJobStatus'
description: Job status.
start_time:
type: string
format: date-time
description: Start time.
x-ms-client-name: startTime
end_time:
type: string
format: date-time
description: End time.
x-ms-client-name: endTime
duration:
type: string
description: Job duration.
output_url:
type: string
description: Output URL.
x-ms-client-name: outputUrl
error_url:
type: string
description: Error URL.
x-ms-client-name: errorUrl
url:
type: string
description: Job URL.
job_name:
type: string
description: Job name.
x-ms-client-name: jobName
trigger:
type: string
description: Job trigger.
SiteConfigurationSnapshotInfo:
type: object
description: A snapshot of a web app configuration.
properties:
properties:
$ref: '#/definitions/SiteConfigurationSnapshotInfoProperties'
description: SiteConfigurationSnapshotInfo resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
WebJobProperties:
type: object
description: WebJob resource specific properties
properties:
run_command:
type: string
description: Run command.
x-ms-client-name: runCommand
url:
type: string
description: Job URL.
extra_info_url:
type: string
description: Extra Info URL.
x-ms-client-name: extraInfoUrl
web_job_type:
$ref: '#/definitions/WebJobType'
description: Job type.
x-ms-client-name: webJobType
error:
type: string
description: Error information.
using_sdk:
type: boolean
description: Using SDK?
x-ms-client-name: usingSdk
settings:
type: object
description: Job settings.
additionalProperties: {}
DeploymentCollection:
type: object
description: Collection of app deployments.
properties:
value:
type: array
description: The Deployment items on this page
items:
$ref: '#/definitions/Deployment'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
PrivateAccess:
type: object
description: Description of the parameters of Private Access for a Web Site.
properties:
properties:
$ref: '#/definitions/PrivateAccessProperties'
description: PrivateAccess resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
ForwardProxyConvention:
type: string
description: The convention used to determine the url of the request made.
enum:
- NoProxy
- Standard
- Custom
x-ms-enum:
name: ForwardProxyConvention
modelAsString: false
DeletedAppRestoreRequestProperties:
type: object
description: DeletedAppRestoreRequest resource specific properties
properties:
deletedSiteId:
type: string
description: 'ARM resource ID of the deleted app. Example:
/subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}'
recoverConfiguration:
type: boolean
description: If true, deleted site configuration, in addition to content, will be restored.
snapshotTime:
type: string
description: 'Point in time to restore the deleted app from, formatted as a DateTime string.
If unspecified, default value is the time that the app was deleted.'
useDRSecondary:
type: boolean
description: If true, the snapshot is retrieved from DRSecondary endpoint.
ConnStringValueTypePair:
type: object
description: Database connection string value to type pair.
properties:
value:
type: string
description: Value of pair.
type:
$ref: '#/definitions/ConnectionStringType'
description: Type of database.
required:
- value
- type
SitePhpErrorLogFlag:
type: object
description: Used for getting PHP error logging flag.
properties:
properties:
$ref: '#/definitions/SitePhpErrorLogFlagProperties'
description: SitePhpErrorLogFlag resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
VnetGateway:
type: object
description: The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.
properties:
properties:
$ref: '#/definitions/VnetGatewayProperties'
description: VnetGateway resource specific properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
BackupSchedule:
type: object
description: Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.
properties:
frequencyInterval:
type: integer
format: int32
description: How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)
default: 7
frequencyUnit:
type: string
description: The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)
default: Day
enum:
- Day
- Hour
x-ms-enum:
name: FrequencyUnit
modelAsString: false
keepAtLeastOneBackup:
type: boolean
description: True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.
default: true
retentionPeriodInDays:
type: integer
format: int32
description: After how many days backups should be deleted.
default: 30
startTime:
type: string
format: date-time
description: When the schedule should start working.
lastExecutionTime:
type: string
format: date-time
description: Last time when this schedule was triggered.
readOnly: true
required:
- frequencyInterval
- frequencyUnit
- keepAtLeastOneBackup
- retentionPeriodInDays
SupportedTlsVersions:
type: string
description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests'
enum:
- '1.0'
- '1.1'
- '1.2'
- '1.3'
x-ms-enum:
name: SupportedTlsVersions
modelAsString: true
values:
- name: '1.0'
value: '1.0'
- name: '1.1'
value: '1.1'
- name: '1.2'
value: '1.2'
- name: '1.3'
value: '1.3'
PrivateAccessVirtualNetwork:
type: object
description: Description of a Virtual Network that is useable for private site access.
properties:
name:
type: string
description: The name of the Virtual Network.
key:
type: integer
format: int32
description: The key (ID) of the Virtual Network.
resourceId:
type: string
description: The ARM uri of the Virtual Network
subnets:
type: array
description: A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.
items:
$ref: '#/definitions/PrivateAccessSubnet'
x-ms-identifiers:
- key
TlsCipherSuites:
type: string
description: The minimum strength TLS cipher suite allowed for an application
enum:
- TLS_AES_256_GCM_SHA384
- TLS_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
x-ms-enum:
name: TlsCipherSuites
modelAsString: true
values:
- name: TLS_AES_256_GCM_SHA384
value: TLS_AES_256_GCM_SHA384
- name: TLS_AES_128_GCM_SHA256
value: TLS_AES_128_GCM_SHA256
- name: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
value: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- name: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
value: TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- name: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
value: TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- name: TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
value: TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- name: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
value: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- name: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
value: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- name: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
value: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- name: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
value: TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- name: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
value: TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- name: TLS_RSA_WITH_AES_256_GCM_SHA384
value: TLS_RSA_WITH_AES_256_GCM_SHA384
- name: TLS_RSA_WITH_AES_128_GCM_SHA256
value: TLS_RSA_WITH_AES_128_GCM_SHA256
- name: TLS_RSA_WITH_AES_256_CBC_SHA256
value: TLS_RSA_WITH_AES_256_CBC_SHA256
- name: TLS_RSA_WITH_AES_128_CBC_SHA256
value: TLS_RSA_WITH_AES_128_CBC_SHA256
- name: TLS_RSA_WITH_AES_256_CBC_SHA
value: TLS_RSA_WITH_AES_256_CBC_SHA
- name: TLS_RSA_WITH_AES_128_CBC_SHA
value: TLS_RSA_WITH_AES_128_CBC_SHA
Twitter:
type: object
description: The configuration settings of the Twitter provider.
properties:
enabled:
type: boolean
description: false if the Twitter provider should not be enabled despite the set registration; otherwise, true.
registration:
$ref: '#/definitions/TwitterRegistration'
description: The configuration settings of the app registration for the Twitter provider.
ApiDefinitionInfo:
type: object
description: Information about the formal API definition for the app.
properties:
url:
type: string
description: The URL of the API definition.
VnetInfo:
type: object
description: Virtual Network information contract.
properties:
vnetResourceId:
type: string
description: The Virtual Network's resource ID.
certThumbprint:
type: string
description: The client certificate thumbprint.
readOnly: true
certBlob:
type: string
description: A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.
routes:
type: array
description: The routes that this Virtual Network connection uses.
items:
$ref: '#/definitions/VnetRoute'
readOnly: true
resyncRequired:
type: boolean
description: true if a resync is required; otherwise, false.
readOnly: true
dnsServers:
type: string
description: DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.
isSwift:
type: boolean
description: Flag that is used to denote if this is VNET injection
RestoreRequest:
type: object
description: Description of a restore request.
properties:
properties:
$ref: '#/definitions/RestoreRequestProperties'
description: RestoreRequest resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
WorkflowEnvelopeProperties:
type: object
description: Additional workflow properties.
properties:
files:
type: object
description: Gets or sets the files.
additionalProperties: {}
flowState:
$ref: '#/definitions/WorkflowState'
description: Gets or sets the state of the workflow.
health:
$ref: '#/definitions/WorkflowHealth'
description: Gets or sets workflow health.
UnauthenticatedClientAction:
type: string
description: The action to take when an unauthenticated client attempts to access the app.
enum:
- RedirectToLoginPage
- AllowAnonymous
x-ms-enum:
name: UnauthenticatedClientAction
modelAsString: false
ClientRegistration:
type: object
description: The configuration settings of the app registration for providers that have client ids and client secrets
properties:
clientId:
type: string
description: The Client ID of the app used for login.
clientSecretSettingName:
type: string
description: The app setting name that contains the client secret.
CookieExpiration:
type: object
description: The configuration settings of the session cookie's expiration.
properties:
convention:
$ref: '#/definitions/CookieExpirationConvention'
description: The convention used when determining the session cookie's expiration.
timeToExpiration:
type: string
description: The time after the request is made when the session cookie should expire.
ProcessInfoCollection:
type: object
description: Collection of Kudu process information elements.
properties:
value:
type: array
description: The ProcessInfo items on this page
items:
$ref: '#/definitions/ProcessInfo'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
DeploymentBuildStatus:
type: string
description: Deployment build status.
enum:
- TimedOut
- RuntimeFailed
- BuildAborted
- BuildFailed
- BuildRequestReceived
- BuildPending
- BuildInProgress
- BuildSuccessful
- PostBuildRestartRequired
- StartPolling
- StartPollingWithRestart
- RuntimeStarting
- RuntimeSuccessful
x-ms-enum:
name: DeploymentBuildStatus
modelAsString: true
values:
- name: TimedOut
value: TimedOut
- name: RuntimeFailed
value: RuntimeFailed
- name: BuildAborted
value: BuildAborted
- name: BuildFailed
value: BuildFailed
- name: BuildRequestReceived
value: BuildRequestReceived
- name: BuildPending
value: BuildPending
- name: BuildInProgress
value: BuildInProgress
- name: BuildSuccessful
value: BuildSuccessful
- name: PostBuildRestartRequired
value: PostBuildRestartRequired
- name: StartPolling
value: StartPolling
- name: StartPollingWithRestart
value: StartPollingWithRestart
- name: RuntimeStarting
value: RuntimeStarting
- name: RuntimeSuccessful
value: RuntimeSuccessful
CsmDeploymentStatusCollection:
type: object
description: Deployment status collection ARM resource.
properties:
value:
type: array
description: The CsmDeploymentStatus items on this page
items:
$ref: '#/definitions/CsmDeploymentStatus'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
DaprLogLevel:
type: string
description: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
enum:
- info
- debug
- warn
- error
x-ms-enum:
name: DaprLogLevel
modelAsString: true
values:
- name: info
value: info
- name: debug
value: debug
- name: warn
value: warn
- name: error
value: error
Facebook:
type: object
description: The configuration settings of the Facebook provider.
properties:
enabled:
type: boolean
description: false if the Facebook provider should not be enabled despite the set registration; otherwise, true.
registration:
$ref: '#/definitions/AppRegistration'
description: The configuration settings of the app registration for the Facebook provider.
graphApiVersion:
type: string
description: The version of the Facebook api to be used while logging in.
login:
$ref: '#/definitions/LoginScopes'
description: The configuration settings of the login flow.
ForwardProxy:
type: object
description: The configuration settings of a forward proxy used to make the requests.
properties:
convention:
$ref: '#/definitions/ForwardProxyConvention'
description: The convention used to determine the url of the request made.
customHostHeaderName:
type: string
description: The name of the header containing the host of the request.
customProtoHeaderName:
type: string
description: The name of the header containing the scheme of the request.
Apple:
type: object
description: The configuration settings of the Apple provider.
properties:
enabled:
type: boolean
description: false if the Apple provider should not be enabled despite the set registration; otherwise, true.
registration:
$ref: '#/definitions/AppleRegistration'
description: The configuration settings of the Apple registration.
login:
$ref: '#/definitions/LoginScopes'
description: The configuration settings of the login flow.
AzureBlobStorageHttpLogsConfig:
type: object
description: Http logs to azure blob storage configuration.
properties:
sasUrl:
type: string
description: SAS url to a azure blob container with read/write/list/delete permissions.
retentionInDays:
type: integer
format: int32
description: 'Retention in days.
Remove blobs older than X days.
0 or lower means no retention.'
enabled:
type: boolean
description: True if configuration is enabled, false if it is disabled and null if configuration is not set.
PublicCertificateLocation:
type: string
description: Public Certificate Location
enum:
- CurrentUserMy
- LocalMachineMy
- Unknown
x-ms-enum:
name: PublicCertificateLocation
modelAsString: false
CsmUsageQuotaCollection:
type: object
description: Paged collection of CsmUsageQuota items
properties:
value:
type: array
description: The CsmUsageQuota items on this page
items:
$ref: '#/definitions/CsmUsageQuota'
x-ms-identifiers:
- name
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
UserProperties:
type: object
description: User resource specific properties
properties:
publishingUserName:
type: string
description: Username used for publishing.
publishingPassword:
type: string
format: password
description: Password used for publishing.
x-ms-secret: true
publishingPasswordHash:
type: string
format: password
description: Password hash used for publishing.
x-ms-secret: true
publishingPasswordHashSalt:
type: string
format: password
description: Password hash salt used for publishing.
x-ms-secret: true
scmUri:
type: string
description: Url of SCM site.
required:
- publishingUserName
DefaultAuthorizationPolicy:
type: object
description: The configuration settings of the Azure Active Directory default authorization policy.
properties:
allowedPrincipals:
$ref: '#/definitions/AllowedPrincipals'
description: The configuration settings of the Azure Active Directory allowed principals.
allowedApplications:
type: array
description: The configuration settings of the Azure Active Directory allowed applications.
items:
type: string
ContainerInfo:
type: object
properties:
currentTimeStamp:
type: string
format: date-time
previousTimeStamp:
type: string
format: date-time
currentCpuStats:
$ref: '#/definitions/ContainerCpuStatistics'
previousCpuStats:
$ref: '#/definitions/ContainerCpuStatistics'
memoryStats:
$ref: '#/definitions/ContainerMemoryStatistics'
name:
type: string
id:
type: string
eth0:
$ref: '#/definitions/ContainerNetworkInterfaceStatistics'
VnetInfoResource:
type: object
description: Virtual Network information ARM resource.
properties:
properties:
$ref: '#/definitions/VnetInfo'
description: Core resource properties
x-ms-client-flatten: true
kind:
type: string
description: Kind of resource.
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
AutoGeneratedDomainNameLabelScope:
type: string
description: Specifies the scope of uniqueness for the default hostname during resource creation
enum:
- TenantReuse
- SubscriptionReuse
- ResourceGroupReuse
- NoReuse
x-ms-enum:
name: AutoGeneratedDomainNameLabelScope
modelAsString: false
OpenIdConnectConfig:
type: object
description: The configuration settings of the endpoints used for the custom Open ID Connect provider.
properties:
authorizationEndpoint:
type: string
description: The endpoint to be used to make an authorization request.
tokenEndpoint:
type: string
description: The endpoint to be used to request a token.
issuer:
type: string
description: The endpoint that issues the token.
certificationUri:
type: string
description: The endpoint that provides the keys necessary to validate the token.
wellKnownOpenIdConfiguration:
type: string
description: The endpoint that contains all the configuration endpoints for the provider.
HostType:
type: string
description: Indicates whether the hostname is a standard or repository hostname.
enum:
- Standard
- Repository
x-ms-enum:
name: HostType
modelAsString: false
SiteAuthSettingsV2Properties:
type: object
description: SiteAuthSettingsV2 resource specific properties
properties:
platform:
$ref: '#/definitions/AuthPlatform'
description: The configuration settings of the platform of App Service Authentication/Authorization.
globalValidation:
$ref: '#/definitions/GlobalValidation'
description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization.
identityProviders:
$ref: '#/definitions/IdentityProviders'
description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization.
login:
$ref: '#/definitions/Login'
description: The configuration settings of the login flow of users using App Service Authentication/Authorization.
httpSettings:
$ref: '#/definitions/HttpSettings'
description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization.
IpFilterTag:
type: string
description: Defines what this IP filter will be used for. This is to support IP filtering on proxies.
enum:
- Default
- XffProxy
- ServiceTag
x-ms-enum:
name: IpFilterTag
modelAsString: true
values:
- name: Default
value: Default
- name: XffProxy
value: XffProxy
- name: ServiceTag
value: ServiceTag
SiteConfig:
type: object
description: Configuration of an App Service app.
properties:
numberOfWorkers:
type: integer
format: int32
description: Number of workers.
defaultDocuments:
type: array
description: Default documents.
items:
type: string
netFrameworkVersion:
type: string
description: .NET Framework version.
default: v4.6
phpVersion:
type: string
description: Version of PHP.
pythonVersion:
type: string
description: Version of Python.
nodeVersion:
type: string
description: Version of Node.js.
powerShellVersion:
type: string
description: Version of PowerShell.
linuxFxVersion:
type: string
description: Linux App Framework and version
windowsFxVersion:
type: string
description: Xenon App Framework and version
requestTracingEnabled:
type: boolean
description: true if request tracing is enabled; otherwise, false.
requestTracingExpirationTime:
type: string
format: date-time
description: Request tracing expiration time.
remoteDebuggingEnabled:
type: boolean
description: true if remote debugging is enabled; otherwise, false.
remoteDebuggingVersion:
type: string
description: Remote debugging version.
httpLoggingEnabled:
type: boolean
description: true if HTTP logging is enabled; otherwise, false.
acrUseManagedIdentityCreds:
type: boolean
description: Flag to use Managed Identity Creds for ACR pull
acrUserManagedIdentityID:
type: string
description: If using user managed identity, the user managed identity ClientId
logsDirectorySizeLimit:
type: integer
format: int32
description: HTTP logs directory size limit.
detailedErrorLoggingEnabled:
type: boolean
description: true if detailed error logging is enabled; otherwise, false.
publishingUsername:
type: string
description: Publishing user name.
appSettings:
type: array
description: Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information.
items:
$ref: '#/definitions/NameValuePair'
x-ms-identifiers:
- name
x-ms-mutability:
- update
- create
metadata:
type: array
description: Application metadata. This property cannot be retrieved, since it may contain secrets.
items:
$ref: '#/definitions/NameValuePair'
x-ms-identifiers:
- name
x-ms-mutability:
- update
- create
connectionStrings:
type: array
description: Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information.
items:
$ref: '#/definitions/ConnStringInfo'
x-ms-identifiers:
- name
x-ms-mutability:
- update
- create
machineKey:
$ref: '#/definitions/SiteMachineKey'
description: Site MachineKey.
readOnly: true
handlerMappings:
type: array
description: Handler mappings.
items:
$ref: '#/definitions/HandlerMapping'
x-ms-identifiers:
- extension
documentRoot:
type: string
description: Document root.
scmType:
$ref: '#/definitions/ScmType'
description: SCM type.
use32BitWorkerProcess:
type: boolean
description: true to use 32-bit worker process; otherwise, false.
webSocketsEnabled:
type: boolean
description: true if WebSocket is enabled; otherwise, false.
alwaysOn:
type: boolean
description: true if Always On is enabled; otherwise, false.
javaVersion:
type: string
description: Java version.
javaContainer:
type: string
description: Java container.
javaContainerVersion:
type: string
description: Java container version.
appCommandLine:
type: string
description: App command line to launch.
managedPipelineMode:
$ref: '#/definitions/ManagedPipelineMode'
description: Managed pipeline mode.
virtualApplications:
type: array
description: Virtual applications.
items:
$ref: '#/definitions/VirtualApplication'
x-ms-identifiers:
- virtualPath
loadBalancing:
$ref: '#/definitions/SiteLoadBalancing'
description: Site load balancing.
experiments:
$ref: '#/definitions/Experiments'
description: This is work around for polymorphic types.
limits:
$ref: '#/definitions/SiteLimits'
description: Site limits.
autoHealEnabled:
type: boolean
description: true if Auto Heal is enabled; otherwise, false.
autoHealRules:
$ref: '#/definitions/AutoHealRules'
description: Auto Heal rules.
tracingOptions:
type: string
description: Tracing options.
vnetName:
type: string
description: Virtual Network name.
x-ms-mutability:
- read
- create
vnetRouteAllEnabled:
type: boolean
description: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.
vnetPrivatePortsCount:
type: integer
format: int32
description: The number of private ports assigned to this app. These will be assigned dynamically on runtime.
cors:
$ref: '#/definitions/CorsSettings'
description: Cross-Origin Resource Sharing (CORS) settings.
push:
$ref: '#/definitions/PushSettings'
description: Push endpoint settings.
apiDefinition:
$ref: '#/definitions/ApiDefinitionInfo'
description: Information about the formal API definition for the app.
apiManagementConfig:
$ref: '#/definitions/ApiManagementConfig'
description: Azure API management settings linked to the app.
autoSwapSlotName:
type: string
description: Auto-swap slot name.
localMySqlEnabled:
type: boolean
description: true to enable local MySQL; otherwise, false.
default: false
managedServiceIdentityId:
type: integer
format: int32
description: Managed Service Identity Id
xManagedServiceIdentityId:
type: integer
format: int32
description: Explicit Managed Service Identity Id
keyVaultReferenceIdentity:
type: string
description: Identity to use for Key Vault Reference authentication.
ipSecurityRestrictions:
type: array
description: IP security restrictions for main.
items:
$ref: '#/definitions/IpSecurityRestriction'
x-ms-identifiers:
- name
ipSecurityRestrictionsDefaultAction:
$ref: '#/definitions/DefaultAction'
description: Default action for main access restriction if no rules are matched.
scmIpSecurityRestrictions:
type: array
description: IP security restrictions for scm.
items:
$ref: '#/definitions/IpSecurityRestriction'
x-ms-identifiers:
- name
scmIpSecurityRestrictionsDefaultAction:
$ref: '#/definitions/DefaultAction'
description: Default action for scm access restriction if no rules are matched.
scmIpSecurityRestrictionsUseMain:
type: boolean
description: IP security restrictions for scm to use main.
http20Enabled:
type: boolean
description: 'Http20Enabled: configures a web site to allow clients to connect over http2.0'
default: true
http20ProxyFlag:
type: integer
format: int32
description: 'Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only.'
default: 0
minTlsVersion:
$ref: '#/definitions/SupportedTlsVersions'
description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests'
minTlsCipherSuite:
$ref: '#/definitions/TlsCipherSuites'
description: The minimum strength TLS cipher suite allowed for an application
scmMinTlsVersion:
$ref: '#/definitions/SupportedTlsVersions'
description: 'ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site'
ftpsState:
$ref: '#/definitions/FtpsState'
description: State of FTP / FTPS service
preWarmedInstanceCount:
type: integer
format: int32
description: 'Number of preWarmed instances.
This setting only applies to the Consumption and Elastic Plans'
minimum: 0
maximum: 10
functionAppScaleLimit:
type: integer
format: int32
description: 'Maximum number of workers that a site can scale out to.
This setting only applies to the Consumption and Elastic Premium Plans'
minimum: 0
elasticWebAppScaleLimit:
type: integer
format: int32
description: 'Maximum number of workers that a site can scale out to.
This setting only applies to apps in plans where ElasticScaleEnabled is true'
minimum: 0
healthCheckPath:
type: string
description: Health check path
functionsRuntimeScaleMonitoringEnabled:
type: boolean
description: 'Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,
the ScaleController will not monitor event sources directly, but will instead call to the
runtime to get scale status.'
websiteTimeZone:
type: string
description: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones
minimumElasticInstanceCount:
type: integer
format: int32
description: 'Number of minimum instance count for a site
This setting only applies to the Elastic Plans'
minimum: 0
maximum: 20
azureStorageAccounts:
type: object
description: List of Azure Storage Accounts.
additionalProperties:
$ref: '#/definitions/AzureStorageInfoValue'
publicNetworkAccess:
type: string
description: Property to allow or block all public traffic.
WorkflowHealthState:
type: string
description: Gets or sets the workflow health state.
enum:
- NotSpecified
- Healthy
- Unhealthy
- Unknown
x-ms-enum:
name: WorkflowHealthState
modelAsString: false
StorageMigrationOptions:
type: object
description: Options for app content migration.
properties:
properties:
$ref: '#/definitions/StorageMigrationOptionsProperties'
description: StorageMigrationOptions resource specific properties
x-ms-client-flatten: true
allOf:
- $ref: '#/definitions/ProxyOnlyResource'
AppRegistration:
type: object
description: The configuration settings of the app registration for providers that have app ids and app secrets
properties:
appId:
type: string
description: The App ID of the app used for login.
appSecretSettingName:
type: string
description: The app setting name that contains the app secret.
GitHubActionContainerConfiguration:
type: object
description: The GitHub action container configuration.
properties:
serverUrl:
type: string
description: The server URL for the container registry where the build will be hosted.
imageName:
type: string
description: The image name for the build.
username:
type: string
description: The username used to upload the image to the container registry.
password:
type: string
format: password
description: The password used to upload the image to the container registry.
x-ms-secret: true
ApplicationLogsConfig:
type: object
description: Application logs configuration.
properties:
fileSystem:
$ref: '#/definitions/FileSystemApplicationLogsConfig'
description: Application logs to file system configuration.
azureTableStorage:
$ref: '#/definitions/AzureTableStorageApplicationLogsConfig'
description: Application logs to azure table storage configuration.
azureBlobStorage:
$ref: '#/definitions/AzureBlobStorageApplicationLogsConfig'
description: Application logs to blob storage configuration.
stringApplicationJson:
type: string
MSDeployProperties:
type: object
description: MSDeploy ARM PUT information properties
properties:
addOnPackages:
type: array
description: List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule.
items:
$ref: '#/definitions/MSDeployCore'
x-ms-identifiers:
- packageUri
allOf:
- $ref: '#/definitions/MSDeployCore'
LoginScopes:
type: object
description: The configuration settings of the login flow, including the scopes that should be requested.
properties:
scopes:
type: array
description: A list of the scopes that should be requested while authenticating.
items:
type: string
GitHubActionConfiguration:
type: object
description: The GitHub action configuration.
properties:
codeConfiguration:
$ref: '#/definitions/GitHubActionCodeConfiguration'
description: GitHub Action code configuration.
containerConfiguration:
$ref: '#/definitions/GitHubActionContainerConfiguration'
description: GitHub Action container configuration.
isLinux:
type: boolean
description: This will help determine the workflow configuration to select.
generateWorkflowFile:
type: boolean
description: Workflow option to determine whether the workflow file should be generated and written to the repository.
LogLevel:
type: string
description: Log level.
enum:
- 'Off'
- Verbose
- Information
- Warning
- Error
x-ms-enum:
name: LogLevel
modelAsString: false
PublishingCredentialsPoliciesCollection:
type: object
description: Publishing Credentials Policies entity collection ARM resource.
properties:
value:
type: array
description: The CsmPublishingCredentialsPoliciesEntity items on this page
items:
$ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
AppleRegistration:
type: object
description: The configuration settings of the registration for the Apple provider
properties:
clientId:
type: string
description: The Client ID of the app used for login.
clientSecretSettingName:
type: string
description: The app setting name that contains the client secret.
Experiments:
type: object
description: Routing rules in production experiments.
properties:
rampUpRules:
type: array
description: List of ramp-up rules.
items:
$ref: '#/definitions/RampUpRule'
x-ms-identifiers:
- name
securityDefinitions:
azure_auth:
type: oauth2
description: Azure Active Directory OAuth2 Flow.
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
user_impersonation: impersonate your user account