openapi: 3.2.0 info: title: Client Web Apps API version: '2025-05-01' x-typespec-generated: - emitter: '@azure-tools/typespec-autorest' servers: - url: https://management.azure.com security: - azure_auth: - user_impersonation tags: - name: Web Apps paths: /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites: get: operationId: WebApps_List tags: - Web Apps 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. content: application/json: schema: $ref: '#/components/schemas/WebAppCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: boolean responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebAppCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Site' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get Web App: $ref: ./examples/GetWebApp.json put: operationId: WebApps_CreateOrUpdate tags: - Web Apps summary: Creates a new web, mobile, or API app in an existing resource group, or updates… 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 schema: type: string responses: '200': description: Resource 'Site' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/Site' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Site' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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 requestBody: content: application/json: schema: $ref: '#/components/schemas/Site' description: A JSON representation of the app properties. See example. required: true patch: operationId: WebApps_Update tags: - Web Apps summary: Creates a new web, mobile, or API app in an existing resource group, or updates… 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Site' '202': description: The request has been accepted for processing, but processing has not yet completed. content: application/json: schema: $ref: '#/components/schemas/Site' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update web app: $ref: ./examples/UpdateWebApp.json requestBody: content: application/json: schema: $ref: '#/components/schemas/SitePatchResource' description: A JSON representation of the app properties. See example. required: true delete: operationId: WebApps_Delete tags: - Web Apps 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 schema: type: string - name: deleteMetrics in: query description: If true, web app metrics are also deleted. required: false schema: 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: hostName in: query description: Custom hostname. required: false schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CustomHostnameAnalysisResult' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Apply web app slot config: $ref: ./examples/ApplySlotConfig.json requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmSlotEntity' description: JSON object that contains the target slot name. See example. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup: post: operationId: WebApps_Backup tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItem' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Backup web app: $ref: ./examples/BackupWebApp.json requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupRequest' description: Backup configuration. You can use the JSON response from the POST action as input here. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups: get: operationId: WebApps_ListBackups tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItemCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: backupId in: path description: ID of the backup. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItem' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get web app backup: $ref: ./examples/GetWebAppBackup.json delete: operationId: WebApps_DeleteBackup tags: - Web Apps 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 schema: type: string - name: backupId in: path description: ID of the backup. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Gets status of a web app backup that may be in progress, including secrets… 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 schema: type: string - name: backupId in: path description: ID of the backup. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItem' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get web app backup with secrets: $ref: ./examples/GetWebAppBackupWithSecrets.json requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupRequest' description: Information on backup request. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore : post: operationId: WebApps_Restore tags: - Web Apps 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 schema: type: string - name: backupId in: path description: ID of the backup. required: true schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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 requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreRequest' description: Information on restore request . required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies : get: operationId: WebApps_ListBasicPublishingCredentialsPolicies tags: - Web Apps summary: Returns whether Scm basic auth is allowed and whether Ftp is allowed for a… 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PublishingCredentialsPoliciesCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get FTP Allowed: $ref: ./examples/GetPublishingCredentialsPolicy_GetFtpAllowed.json put: operationId: WebApps_UpdateFtpAllowed tags: - Web Apps 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 schema: type: string responses: '200': description: Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update FTP Allowed: $ref: ./examples/UpdatePublishingCredentialsPolicy_UpdateFtpAllowed.json requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm : get: operationId: WebApps_GetScmAllowed tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get SCM Allowed: $ref: ./examples/GetPublishingCredentialsPolicy.json put: operationId: WebApps_UpdateScmAllowed tags: - Web Apps 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 schema: type: string responses: '200': description: Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update SCM Allowed: $ref: ./examples/UpdatePublishingCredentialsPolicy.json requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config: get: operationId: WebApps_ListConfigurations tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigResourceCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update App Settings: $ref: ./examples/UpdateAppSettings.json requestBody: content: application/json: schema: $ref: '#/components/schemas/StringDictionary' description: Application settings of the app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list : post: operationId: WebApps_ListApplicationSettings tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettings' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update Auth Settings: $ref: ./examples/UpdateAuthSettings.json requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettings' description: Auth settings associated with web app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list : post: operationId: WebApps_GetAuthSettings tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettings' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettingsV2' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: List Auth Settings without Secrets: $ref: ./examples/GetAuthSettingsV2WithoutSecrets.json put: operationId: WebApps_UpdateAuthSettingsV2 tags: - Web Apps summary: Updates site's Authentication / Authorization settings for apps via the V2… 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 schema: type: string responses: '200': description: Resource 'SiteAuthSettingsV2' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettingsV2' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update Auth Settings V2: $ref: ./examples/UpdateAuthSettingsV2.json requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettingsV2' description: Auth settings associated with web app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list : get: operationId: WebApps_GetAuthSettingsV2 tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettingsV2' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/AzureStoragePropertyDictionaryResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update Azure Storage Accounts: $ref: ./examples/UpdateAzureStorageAccounts.json requestBody: content: application/json: schema: $ref: '#/components/schemas/AzureStoragePropertyDictionaryResource' description: Azure storage accounts of the app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list : post: operationId: WebApps_ListAzureStorageAccounts tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/AzureStoragePropertyDictionaryResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup: put: operationId: WebApps_UpdateBackupConfiguration tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupRequest' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupRequest' description: Edited backup configuration. required: true delete: operationId: WebApps_DeleteBackupConfiguration tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list: post: operationId: WebApps_GetBackupConfiguration tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupRequest' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings : get: operationId: WebApps_GetAppSettingsKeyVaultReferences tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ApiKVReferenceCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: appSettingKey in: path description: App Setting key name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ApiKVReference' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ApiKVReferenceCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings/{connectionStringKey} : get: operationId: WebApps_GetSiteConnectionStringKeyVaultReference tags: - Web Apps 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 schema: type: string - name: connectionStringKey in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ApiKVReference' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings : put: operationId: WebApps_UpdateConnectionStrings tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ConnectionStringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionStringDictionary' description: Connection strings of the app or deployment slot. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list : post: operationId: WebApps_ListConnectionStrings tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ConnectionStringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs: get: operationId: WebApps_GetDiagnosticLogsConfiguration tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteLogsConfig' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_UpdateDiagnosticLogsConfig tags: - Web Apps 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 schema: type: string responses: '200': description: Resource 'SiteLogsConfig' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteLogsConfig' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteLogsConfig' description: A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties"property required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata: put: operationId: WebApps_UpdateMetadata tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/StringDictionary' description: Edited metadata of the app or deployment slot. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list : post: operationId: WebApps_ListMetadata tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list : post: operationId: WebApps_ListPublishingCredentials tags: - Web Apps 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 schema: type: string responses: '200': description: The request has succeeded. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/User' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PushSettings' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PushSettings' description: Push settings associated with web app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list : post: operationId: WebApps_ListSitePushSettings tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PushSettings' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames : get: operationId: WebApps_ListSlotConfigurationNames tags: - Web Apps summary: Gets the names of app settings and connection strings that stick to the slot… 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SlotConfigNamesResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_UpdateSlotConfigurationNames tags: - Web Apps summary: Updates the names of application settings and connection string that remain… 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 schema: type: string responses: '200': description: Resource 'SlotConfigNamesResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SlotConfigNamesResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SlotConfigNamesResource' description: Names of application settings and connection strings. See example. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web: get: operationId: WebApps_GetConfiguration tags: - Web Apps summary: Gets the configuration of an app, such as platform version and bitness, default… 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get Site Config: $ref: ./examples/GetSiteConfig.json put: operationId: WebApps_CreateOrUpdateConfiguration tags: - Web Apps 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 schema: type: string responses: '200': description: Resource 'SiteConfigResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update Site Config: $ref: ./examples/UpdateSiteConfig.json requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' description: JSON representation of a SiteConfig object. See example. required: true patch: operationId: WebApps_UpdateConfiguration tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' description: JSON representation of a SiteConfig object. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots : get: operationId: WebApps_ListConfigurationSnapshotInfo tags: - Web Apps summary: Gets a list of web app configuration snapshots identifiers. 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigurationSnapshotInfoCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId} : get: operationId: WebApps_GetConfigurationSnapshot tags: - Web Apps 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 schema: type: string - name: snapshotId in: path description: The ID of the snapshot to read. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover : post: operationId: WebApps_RecoverSiteConfigurationSnapshot tags: - Web Apps 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 schema: type: string - name: snapshotId in: path description: The ID of the snapshot to read. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs: post: operationId: WebApps_GetWebSiteContainerLogs tags: - Web Apps 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 parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the app. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/octet-stream: schema: type: string format: binary application/json: schema: type: string format: binary '204': description: There is no content to send for this request, but the headers may be useful. default: description: An unexpected error response. content: application/octet-stream: schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download : post: operationId: WebApps_GetContainerLogsZip tags: - Web Apps 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 parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the app. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/zip: schema: type: string format: binary application/json: schema: type: string format: binary '204': description: There is no content to send for this request, but the headers may be useful. default: description: An unexpected error response. content: application/zip: schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs: get: operationId: WebApps_ListContinuousWebJobs tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ContinuousWebJobCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName} : get: operationId: WebApps_GetContinuousWebJob tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ContinuousWebJob' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' delete: operationId: WebApps_DeleteContinuousWebJob tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start : post: operationId: WebApps_StartContinuousWebJob tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop : post: operationId: WebApps_StopContinuousWebJob tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployWorkflowArtifacts : post: operationId: WebApps_DeployWorkflowArtifacts tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Delete workflow artifacts: $ref: ./examples/DeleteDeployWorkflowArtifacts.json Deploys workflow artifacts: $ref: ./examples/PostDeployWorkflowArtifacts.json requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowArtifacts' description: Application settings and files of the workflow. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus: get: operationId: WebApps_ListProductionSiteDeploymentStatuses tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmDeploymentStatusCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: deploymentStatusId in: path description: GUID of the deployment operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmDeploymentStatus' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/CsmDeploymentStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}: get: operationId: WebApps_GetDeployment tags: - Web Apps 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 schema: type: string - name: id in: path description: Deployment ID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Deployment' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateDeployment tags: - Web Apps 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 schema: type: string - name: id in: path description: Deployment ID. required: true schema: type: string responses: '200': description: Resource 'Deployment' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/Deployment' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/Deployment' description: Deployment details. required: true delete: operationId: WebApps_DeleteDeployment tags: - Web Apps 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 schema: type: string - name: id in: path description: Deployment ID. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log : get: operationId: WebApps_ListDeploymentLog tags: - Web Apps 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 schema: type: string - name: id in: path description: Deployment ID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Deployment' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup: post: operationId: WebApps_DiscoverBackup tags: - Web Apps summary: Discovers an existing app backup that can be restored from a blob in Azure… 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RestoreRequest' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreRequest' description: A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers : get: operationId: WebApps_ListDomainOwnershipIdentifiers tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/IdentifierCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} : get: operationId: WebApps_GetDomainOwnershipIdentifier tags: - Web Apps 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 schema: type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Identifier' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateDomainOwnershipIdentifier tags: - Web Apps summary: Creates a domain ownership identifier for web app, or updates an existing… 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 schema: type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true schema: type: string responses: '200': description: Resource 'Identifier' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/Identifier' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/Identifier' description: A JSON representation of the domain ownership properties. required: true patch: operationId: WebApps_UpdateDomainOwnershipIdentifier tags: - Web Apps summary: Creates a domain ownership identifier for web app, or updates an existing… 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 schema: type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Identifier' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/Identifier' description: A JSON representation of the domain ownership properties. required: true delete: operationId: WebApps_DeleteDomainOwnershipIdentifier tags: - Web Apps 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 schema: type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy : get: operationId: WebApps_GetMSDeployStatus tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MSDeployStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateMSDeployOperation tags: - Web Apps 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 schema: type: string responses: '201': description: Resource 'MSDeployStatus' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/MSDeployStatus' '409': description: The request conflicts with the current state of the server. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/MSDeployStatus' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/MSDeploy' description: Details of MSDeploy operation required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log : get: operationId: WebApps_GetMSDeployLog tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MSDeployLog' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy : get: operationId: WebApps_GetOneDeployStatus tags: - Web Apps summary: Invoke onedeploy status API /api/deployments and gets the deployment status for… 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: {} default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOneDeployOperation tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: {} default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions: get: operationId: WebApps_ListFunctions tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/FunctionEnvelopeCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName} : get: operationId: WebApps_GetFunction tags: - Web Apps 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 schema: type: string - name: functionName in: path description: Function name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/FunctionEnvelope' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateFunction tags: - Web Apps 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 schema: type: string - name: functionName in: path description: Function name. required: true schema: type: string responses: '201': description: Resource 'FunctionEnvelope' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/FunctionEnvelope' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/FunctionEnvelope' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/FunctionEnvelope' description: Function details. required: true delete: operationId: WebApps_DeleteFunction tags: - Web Apps 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 schema: type: string - name: functionName in: path description: Function name. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listkeys : post: operationId: WebApps_ListFunctionKeys tags: - Web Apps 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 schema: type: string - name: functionName in: path description: Function name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets : post: operationId: WebApps_ListFunctionSecrets tags: - Web Apps 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 schema: type: string - name: functionName in: path description: Function name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/FunctionSecrets' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token : get: operationId: WebApps_GetFunctionsAdminToken tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/stringApplicationJson' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys : post: operationId: WebApps_ListHostKeys tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HostKeys' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus : post: operationId: WebApps_ListSyncStatus tags: - Web Apps 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync: post: operationId: WebApps_SyncFunctions tags: - Web Apps 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings: get: operationId: WebApps_ListHostNameBindings tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HostNameBindingCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName} : get: operationId: WebApps_GetHostNameBinding tags: - Web Apps 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 schema: type: string - name: hostName in: path description: Hostname in the hostname binding. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HostNameBinding' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateHostNameBinding tags: - Web Apps 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 schema: type: string - name: hostName in: path description: Hostname in the hostname binding. required: true schema: type: string responses: '200': description: Resource 'HostNameBinding' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/HostNameBinding' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/HostNameBinding' description: Binding details. This is the JSON representation of a HostNameBinding object. required: true delete: operationId: WebApps_DeleteHostNameBinding tags: - Web Apps 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 schema: type: string - name: hostName in: path description: Hostname in the hostname binding. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} : get: operationId: WebApps_GetHybridConnection tags: - Web Apps 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 schema: type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true schema: type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HybridConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateHybridConnection tags: - Web Apps 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 schema: type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true schema: type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true schema: type: string responses: '200': description: Resource 'HybridConnection' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/HybridConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/HybridConnection' description: The details of the hybrid connection. required: true patch: operationId: WebApps_UpdateHybridConnection tags: - Web Apps 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 schema: type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true schema: type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HybridConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/HybridConnection' description: The details of the hybrid connection. required: true delete: operationId: WebApps_DeleteHybridConnection tags: - Web Apps 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 schema: type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true schema: type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays : get: operationId: WebApps_ListHybridConnections tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HybridConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection: get: operationId: WebApps_ListRelayServiceConnections tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName} : get: operationId: WebApps_GetRelayServiceConnection tags: - Web Apps 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 schema: type: string - name: entityName in: path description: Name of the hybrid connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateRelayServiceConnection tags: - Web Apps summary: Creates a new hybrid connection configuration (PUT), or updates an existing one… 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 schema: type: string - name: entityName in: path description: Name of the hybrid connection. required: true schema: type: string responses: '200': description: Resource 'RelayServiceConnectionEntity' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' description: Details of the hybrid connection configuration. required: true patch: operationId: WebApps_UpdateRelayServiceConnection tags: - Web Apps summary: Creates a new hybrid connection configuration (PUT), or updates an existing one… 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 schema: type: string - name: entityName in: path description: Name of the hybrid connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' description: Details of the hybrid connection configuration. required: true delete: operationId: WebApps_DeleteRelayServiceConnection tags: - Web Apps 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 schema: type: string - name: entityName in: path description: Name of the hybrid connection. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances: get: operationId: WebApps_ListInstanceIdentifiers tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebAppInstanceStatusCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId} : get: operationId: WebApps_GetInstanceInfo tags: - Web Apps 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 schema: type: string - name: instanceId in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebSiteInstanceStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: instanceId in: path description: ID of web app instance. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MSDeployStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateInstanceMSDeployOperation tags: - Web Apps 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 schema: type: string - name: instanceId in: path description: ID of web app instance. required: true schema: type: string responses: '201': description: Resource 'MSDeployStatus' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/MSDeployStatus' '409': description: The request conflicts with the current state of the server. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/MSDeployStatus' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/MSDeploy' description: Details of MSDeploy operation required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log : get: operationId: WebApps_GetInstanceMSDeployLog tags: - Web Apps 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 schema: type: string - name: instanceId in: path description: ID of web app instance. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MSDeployLog' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes : get: operationId: WebApps_ListInstanceProcesses tags: - Web Apps summary: Get list of processes for a web site, or a deployment slot, or for a specific… 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId} : get: operationId: WebApps_GetInstanceProcess tags: - Web Apps summary: Get process information by its ID for a specific scaled-out instance in a web… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' delete: operationId: WebApps_DeleteInstanceProcess tags: - Web Apps summary: Terminate a process by its ID for a web site, or a deployment slot, or specific… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump : get: operationId: WebApps_GetInstanceProcessDump tags: - Web Apps summary: Get a memory dump of a process by its ID for a specific scaled-out instance in… description: Description for Get a memory dump of 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: '*/*': schema: type: string format: binary application/json: schema: type: string format: binary '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: '*/*': schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules : get: operationId: WebApps_ListInstanceProcessModules tags: - Web Apps summary: List module information for a process by its ID for a specific scaled-out… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessModuleInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Get process information by its ID for a specific scaled-out instance in a web… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string - name: baseAddress in: path description: Module base address. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessModuleInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads : get: operationId: WebApps_ListInstanceProcessThreads tags: - Web Apps summary: List the threads in a process by its ID for a specific scaled-out instance in a… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessThreadInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable: post: operationId: WebApps_IsCloneable tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteCloneability' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listWorkflowsConnections : post: operationId: WebApps_ListWorkflowsConnections tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WorkflowEnvelope' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItemCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/FunctionSecrets' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate: put: operationId: WebApps_MigrateStorage tags: - Web Apps 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 schema: type: string - name: subscriptionName in: query description: Azure subscription required: true schema: type: string responses: '200': description: The request has succeeded. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/StorageMigrationResponse' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/StorageMigrationResponse' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/StorageMigrationOptions' description: Migration migrationOptions. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql: post: operationId: WebApps_MigrateMySql tags: - Web Apps 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 schema: type: string responses: '200': description: The request has succeeded. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Operation' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/Operation' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrateMySqlRequest' description: MySql migration options. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status : get: operationId: WebApps_GetMigrateMySqlStatus tags: - Web Apps summary: Returns the status of MySql in app migration, if one is active, and whether or… 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MigrateMySqlStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork : get: operationId: WebApps_GetSwiftVirtualNetworkConnection tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheck tags: - Web Apps summary: Integrates this Web App with a Virtual Network. 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 schema: type: string responses: '200': description: Resource 'SwiftVirtualNetwork' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' description: Properties of the Virtual Network connection. See example. required: true patch: operationId: WebApps_UpdateSwiftVirtualNetworkConnectionWithCheck tags: - Web Apps summary: Integrates this Web App with a Virtual Network. 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' description: Properties of the Virtual Network connection. See example. required: true delete: operationId: WebApps_DeleteSwiftVirtualNetwork tags: - Web Apps 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view} : get: operationId: WebApps_ListNetworkFeatures tags: - Web Apps 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 schema: type: string - name: view in: path description: The type of view. Only "summary" is supported at this time. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/NetworkFeatures' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start: post: operationId: WebApps_StartWebSiteNetworkTrace tags: - Web Apps 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 schema: type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. required: false schema: type: integer format: int32 - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). required: false schema: type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. required: false schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/stringApplicationJson' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation : post: operationId: WebApps_StartWebSiteNetworkTraceOperation tags: - Web Apps 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 schema: type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. required: false schema: type: integer format: int32 - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). required: false schema: type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. required: false schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' '202': description: Azure operation completed successfully. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Generates a new publishing password for an app (or deployment slot, if… 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters: get: operationId: WebApps_ListPerfMonCounters tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PerfMonCounterCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging: get: operationId: WebApps_GetSitePhpErrorLogFlag tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SitePhpErrorLogFlag' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons: get: operationId: WebApps_ListPremierAddOns tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName} : get: operationId: WebApps_GetPremierAddOn tags: - Web Apps 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 schema: type: string - name: premierAddOnName in: path description: Add-on name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_AddPremierAddOn tags: - Web Apps 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 schema: type: string - name: premierAddOnName in: path description: Add-on name. required: true schema: type: string responses: '200': description: Resource 'PremierAddOn' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' description: A JSON representation of the edited premier add-on. required: true patch: operationId: WebApps_UpdatePremierAddOn tags: - Web Apps 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 schema: type: string - name: premierAddOnName in: path description: Add-on name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PremierAddOnPatchResource' description: A JSON representation of the edited premier add-on. required: true delete: operationId: WebApps_DeletePremierAddOn tags: - Web Apps 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 schema: type: string - name: premierAddOnName in: path description: Add-on name. required: true schema: type: string responses: '200': description: Resource deleted successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks : get: operationId: WebApps_GetPrivateAccess tags: - Web Apps summary: Gets data around private site access enablement and authorized Virtual Networks… 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateAccess' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_PutPrivateAccessVnet tags: - Web Apps summary: Sets data around private site access enablement and authorized Virtual Networks… 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 schema: type: string responses: '200': description: Resource 'PrivateAccess' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/PrivateAccess' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateAccess' description: The information for the private access required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections : get: operationId: WebApps_GetPrivateEndpointConnectionList tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName} : get: operationId: WebApps_GetPrivateEndpointConnection tags: - Web Apps 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 schema: type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get a private endpoint connection for a site.: $ref: ./examples/GetSitePrivateEndpointConnection.json put: operationId: WebApps_ApproveOrRejectPrivateEndpointConnection tags: - Web Apps 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 schema: type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true schema: type: string responses: '200': description: Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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 requestBody: content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' required: true delete: operationId: WebApps_DeletePrivateEndpointConnection tags: - Web Apps 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 schema: type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: {} '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: {} '204': description: 'There is no content to send for this request, but the headers may be useful. ' content: application/json: schema: {} default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateLinkResourcesWrapper' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Get list of processes for a web site, or a deployment slot, or for a specific… 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId} : get: operationId: WebApps_GetProcess tags: - Web Apps summary: Get process information by its ID for a specific scaled-out instance in a web… 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' delete: operationId: WebApps_DeleteProcess tags: - Web Apps summary: Terminate a process by its ID for a web site, or a deployment slot, or specific… 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 schema: type: string - name: processId in: path description: PID. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump : get: operationId: WebApps_GetProcessDump tags: - Web Apps summary: Get a memory dump of a process by its ID for a specific scaled-out instance in… description: Description for Get a memory dump of 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: '*/*': schema: type: string format: binary application/json: schema: type: string format: binary '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: '*/*': schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules : get: operationId: WebApps_ListProcessModules tags: - Web Apps summary: List module information for a process by its ID for a specific scaled-out… 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessModuleInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress} : get: operationId: WebApps_GetProcessModule tags: - Web Apps summary: Get process information by its ID for a specific scaled-out instance in a web… 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string - name: baseAddress in: path description: Module base address. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessModuleInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads : get: operationId: WebApps_ListProcessThreads tags: - Web Apps summary: List the threads in a process by its ID for a specific scaled-out instance in a… 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessThreadInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates: get: operationId: WebApps_ListPublicCertificates tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PublicCertificateCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName} : get: operationId: WebApps_GetPublicCertificate tags: - Web Apps 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 schema: type: string - name: publicCertificateName in: path description: Public certificate name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PublicCertificate' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdatePublicCertificate tags: - Web Apps 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 schema: type: string - name: publicCertificateName in: path description: Public certificate name. required: true schema: type: string responses: '200': description: Resource 'PublicCertificate' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/PublicCertificate' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PublicCertificate' description: Public certificate details. This is the JSON representation of a PublicCertificate object. required: true delete: operationId: WebApps_DeletePublicCertificate tags: - Web Apps 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 schema: type: string - name: publicCertificateName in: path description: Public certificate name. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml: post: operationId: WebApps_ListPublishingProfileXmlWithSecrets tags: - Web Apps 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). parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the app. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/xml: schema: type: string format: binary application/json: schema: type: string format: binary default: description: An unexpected error response. content: application/xml: schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmPublishingProfileOptions' description: 'Specifies publishingProfileOptions for publishing profile. For example, use {" format": "FileZilla3"} to get a FileZilla publishing profile.' required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig: post: operationId: WebApps_ResetProductionSlotConfig tags: - Web Apps summary: Resets the configuration settings of the current slot if they were previously… 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 schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart: post: operationId: WebApps_Restart tags: - Web Apps 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 schema: 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 schema: 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 schema: type: boolean responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob : post: operationId: WebApps_RestoreFromBackupBlob tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreRequest' description: Information on restore request . required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp : post: operationId: WebApps_RestoreFromDeletedApp tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/DeletedAppRestoreRequest' description: Deleted web app restore information. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot: post: operationId: WebApps_RestoreSnapshot tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SnapshotRestoreRequest' description: Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers: get: operationId: WebApps_ListSiteContainers tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteContainerCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName} : get: operationId: WebApps_GetSiteContainer tags: - Web Apps 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 schema: type: string - name: containerName in: path description: Site Container Name required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/SiteContainer' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateSiteContainer tags: - Web Apps 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 schema: type: string - name: containerName in: path description: Site Container Name required: true schema: type: string pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$) responses: '200': description: Resource 'SiteContainer' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteContainer' '201': description: Resource 'SiteContainer' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteContainer' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteContainer' description: Container Entity required: true delete: operationId: WebApps_DeleteSiteContainer tags: - Web Apps 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 schema: type: string - name: containerName in: path description: Site Container Name required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions: get: operationId: WebApps_ListSiteExtensions tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteExtensionInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId} : get: operationId: WebApps_GetSiteExtension tags: - Web Apps 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 schema: type: string - name: siteExtensionId in: path description: Site extension name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteExtensionInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_InstallSiteExtension tags: - Web Apps 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 schema: type: string - name: siteExtensionId in: path description: Site extension name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteExtensionInfo' '201': description: Resource 'SiteExtensionInfo' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/SiteExtensionInfo' '429': description: Client error x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: siteExtensionId in: path description: Site extension name. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots: get: operationId: WebApps_ListSlots tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebAppCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Site' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get Web App Slot: $ref: ./examples/GetWebAppSlot.json put: operationId: WebApps_CreateOrUpdateSlot tags: - Web Apps summary: Creates a new web, mobile, or API app in an existing resource group, or updates… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Resource 'Site' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/Site' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Site' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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 requestBody: content: application/json: schema: $ref: '#/components/schemas/Site' description: A JSON representation of the app properties. See example. required: true patch: operationId: WebApps_UpdateSlot tags: - Web Apps summary: Creates a new web, mobile, or API app in an existing resource group, or updates… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Site' '202': description: The request has been accepted for processing, but processing has not yet completed. content: application/json: schema: $ref: '#/components/schemas/Site' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update Web App Slot: $ref: ./examples/UpdateWebAppSlot.json requestBody: content: application/json: schema: $ref: '#/components/schemas/SitePatchResource' description: A JSON representation of the app properties. See example. required: true delete: operationId: WebApps_DeleteSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: deleteMetrics in: query description: If true, web app metrics are also deleted. required: false schema: 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: hostName in: query description: Custom hostname. required: false schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CustomHostnameAnalysisResult' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmSlotEntity' description: JSON object that contains the target slot name. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup : post: operationId: WebApps_BackupSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItem' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupRequest' description: Backup configuration. You can use the JSON response from the POST action as input here. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups : get: operationId: WebApps_ListBackupsSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItemCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId} : get: operationId: WebApps_GetBackupStatusSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: backupId in: path description: ID of the backup. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItem' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' delete: operationId: WebApps_DeleteBackupSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: backupId in: path description: ID of the backup. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list : post: operationId: WebApps_ListBackupStatusSecretsSlot tags: - Web Apps summary: Gets status of a web app backup that may be in progress, including secrets… 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 schema: 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 schema: type: string - name: backupId in: path description: ID of the backup. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItem' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupRequest' description: Information on backup request. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore : post: operationId: WebApps_RestoreSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: backupId in: path description: ID of the backup. required: true schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreRequest' description: Information on restore request . required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies : get: operationId: WebApps_ListBasicPublishingCredentialsPoliciesSlot tags: - Web Apps summary: Returns whether Scm basic auth is allowed and whether Ftp is allowed for a… 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 schema: type: string - name: slot in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PublishingCredentialsPoliciesCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get FTP Allowed: $ref: ./examples/GetPublishingCredentialsPolicySlot_FtpAllowedSlot.json put: operationId: WebApps_UpdateFtpAllowedSlot tags: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string responses: '200': description: Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update FTP Allowed: $ref: ./examples/UpdatePublishingCredentialsPolicySlot_UpdateFtpAllowedSlot.json requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm : get: operationId: WebApps_GetScmAllowedSlot tags: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get SCM Allowed: $ref: ./examples/GetPublishingCredentialsPolicySlot.json put: operationId: WebApps_UpdateScmAllowedSlot tags: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string responses: '200': description: Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Update SCM Allowed: $ref: ./examples/UpdatePublishingCredentialsPolicySlot.json requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config : get: operationId: WebApps_ListConfigurationsSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigResourceCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings : put: operationId: WebApps_UpdateApplicationSettingsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/StringDictionary' description: Application settings of the app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list : post: operationId: WebApps_ListApplicationSettingsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings : put: operationId: WebApps_UpdateAuthSettingsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettings' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettings' description: Auth settings associated with web app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list : post: operationId: WebApps_GetAuthSettingsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettings' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2 : get: operationId: WebApps_GetAuthSettingsV2WithoutSecretsSlot tags: - Web Apps summary: 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettingsV2' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_UpdateAuthSettingsV2Slot tags: - Web Apps summary: Updates site's Authentication / Authorization settings for apps via the V2… 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 schema: 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 schema: type: string responses: '200': description: Resource 'SiteAuthSettingsV2' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettingsV2' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettingsV2' description: Auth settings associated with web app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list : get: operationId: WebApps_GetAuthSettingsV2Slot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteAuthSettingsV2' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts : put: operationId: WebApps_UpdateAzureStorageAccountsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/AzureStoragePropertyDictionaryResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/AzureStoragePropertyDictionaryResource' description: Azure storage accounts of the app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list : post: operationId: WebApps_ListAzureStorageAccountsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/AzureStoragePropertyDictionaryResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup : put: operationId: WebApps_UpdateBackupConfigurationSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupRequest' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/BackupRequest' description: Edited backup configuration. required: true delete: operationId: WebApps_DeleteBackupConfigurationSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list : post: operationId: WebApps_GetBackupConfigurationSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupRequest' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings : get: operationId: WebApps_GetAppSettingsKeyVaultReferencesSlot tags: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ApiKVReferenceCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string - name: appSettingKey in: path description: App Setting key name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ApiKVReference' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ApiKVReferenceCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string - name: connectionStringKey in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ApiKVReference' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings : put: operationId: WebApps_UpdateConnectionStringsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ConnectionStringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionStringDictionary' description: Connection strings of the app or deployment slot. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list : post: operationId: WebApps_ListConnectionStringsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ConnectionStringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs : get: operationId: WebApps_GetDiagnosticLogsConfigurationSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteLogsConfig' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_UpdateDiagnosticLogsConfigSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Resource 'SiteLogsConfig' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteLogsConfig' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteLogsConfig' description: A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties"property required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata : put: operationId: WebApps_UpdateMetadataSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/StringDictionary' description: Edited metadata of the app or deployment slot. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list : post: operationId: WebApps_ListMetadataSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list : post: operationId: WebApps_ListPublishingCredentialsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: If true, the password is included in the response. The default is false. required: true schema: type: string responses: '200': description: The request has succeeded. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/User' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PushSettings' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PushSettings' description: Push settings associated with web app. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list : post: operationId: WebApps_ListSitePushSettingsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PushSettings' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web : get: operationId: WebApps_GetConfigurationSlot tags: - Web Apps summary: Gets the configuration of an app, such as platform version and bitness, default… 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateConfigurationSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Resource 'SiteConfigResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' description: JSON representation of a SiteConfig object. See example. required: true patch: operationId: WebApps_UpdateConfigurationSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' description: JSON representation of a SiteConfig object. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots : get: operationId: WebApps_ListConfigurationSnapshotInfoSlot tags: - Web Apps summary: Gets a list of web app configuration snapshots identifiers. 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigurationSnapshotInfoCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: 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 schema: type: string - name: snapshotId in: path description: The ID of the snapshot to read. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteConfigResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover : post: operationId: WebApps_RecoverSiteConfigurationSnapshotSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: snapshotId in: path description: The ID of the snapshot to read. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs : post: operationId: WebApps_GetWebSiteContainerLogsSlot tags: - Web Apps 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 parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the app. required: true schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/octet-stream: schema: type: string format: binary application/json: schema: type: string format: binary '204': description: There is no content to send for this request, but the headers may be useful. default: description: An unexpected error response. content: application/octet-stream: schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download : post: operationId: WebApps_GetContainerLogsZipSlot tags: - Web Apps 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 parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the app. required: true schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/zip: schema: type: string format: binary application/json: schema: type: string format: binary '204': description: There is no content to send for this request, but the headers may be useful. default: description: An unexpected error response. content: application/zip: schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs : get: operationId: WebApps_ListContinuousWebJobsSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ContinuousWebJobCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName} : get: operationId: WebApps_GetContinuousWebJobSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ContinuousWebJob' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' delete: operationId: WebApps_DeleteContinuousWebJobSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start : post: operationId: WebApps_StartContinuousWebJobSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop : post: operationId: WebApps_StopContinuousWebJobSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployWorkflowArtifacts : post: operationId: WebApps_DeployWorkflowArtifactsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Deploys workflow artifacts slot: $ref: ./examples/PostDeployWorkflowArtifactsSlot.json requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowArtifacts' description: Application settings and files of the workflow. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus : get: operationId: WebApps_ListSlotSiteDeploymentStatusesSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmDeploymentStatusCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: 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 schema: type: string - name: deploymentStatusId in: path description: GUID of the deployment operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmDeploymentStatus' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/CsmDeploymentStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/DeploymentCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id} : get: operationId: WebApps_GetDeploymentSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: id in: path description: Deployment ID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Deployment' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateDeploymentSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: id in: path description: Deployment ID. required: true schema: type: string responses: '200': description: Resource 'Deployment' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/Deployment' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/Deployment' description: Deployment details. required: true delete: operationId: WebApps_DeleteDeploymentSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: id in: path description: Deployment ID. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log : get: operationId: WebApps_ListDeploymentLogSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: id in: path description: Deployment ID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Deployment' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup : post: operationId: WebApps_DiscoverBackupSlot tags: - Web Apps summary: Discovers an existing app backup that can be restored from a blob in Azure… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RestoreRequest' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreRequest' description: A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers : get: operationId: WebApps_ListDomainOwnershipIdentifiersSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/IdentifierCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} : get: operationId: WebApps_GetDomainOwnershipIdentifierSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Identifier' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot tags: - Web Apps summary: Creates a domain ownership identifier for web app, or updates an existing… 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 schema: 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 schema: type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true schema: type: string responses: '200': description: Resource 'Identifier' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/Identifier' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/Identifier' description: A JSON representation of the domain ownership properties. required: true patch: operationId: WebApps_UpdateDomainOwnershipIdentifierSlot tags: - Web Apps summary: Creates a domain ownership identifier for web app, or updates an existing… 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 schema: 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 schema: type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/Identifier' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/Identifier' description: A JSON representation of the domain ownership properties. required: true delete: operationId: WebApps_DeleteDomainOwnershipIdentifierSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy : get: operationId: WebApps_GetMSDeployStatusSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of web app slot. If not specified then will default to production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MSDeployStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateMSDeployOperationSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of web app slot. If not specified then will default to production slot. required: true schema: type: string responses: '201': description: Resource 'MSDeployStatus' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/MSDeployStatus' '409': description: The request conflicts with the current state of the server. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/MSDeployStatus' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/MSDeploy' description: Details of MSDeploy operation required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log : get: operationId: WebApps_GetMSDeployLogSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of web app slot. If not specified then will default to production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MSDeployLog' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions : get: operationId: WebApps_ListInstanceFunctionsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/FunctionEnvelopeCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName} : get: operationId: WebApps_GetInstanceFunctionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. required: true schema: type: string - name: functionName in: path description: Function name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/FunctionEnvelope' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateInstanceFunctionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. required: true schema: type: string - name: functionName in: path description: Function name. required: true schema: type: string responses: '201': description: Resource 'FunctionEnvelope' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/FunctionEnvelope' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/FunctionEnvelope' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/FunctionEnvelope' description: Function details. required: true delete: operationId: WebApps_DeleteInstanceFunctionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. required: true schema: type: string - name: functionName in: path description: Function name. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName} : put: operationId: WebApps_CreateOrUpdateFunctionSecretSlot tags: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string - name: functionName in: path required: true schema: type: string - name: keyName in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/KeyInfo' '201': description: Resource 'KeyInfo' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/KeyInfo' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/KeyInfo' description: The key to create or update required: true delete: operationId: WebApps_DeleteFunctionSecretSlot tags: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string - name: functionName in: path required: true schema: type: string - name: keyName in: path required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys : post: operationId: WebApps_ListFunctionKeysSlot tags: - Web Apps 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 schema: type: string - name: slot in: path required: true schema: type: string - name: functionName in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/StringDictionary' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets : post: operationId: WebApps_ListFunctionSecretsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. required: true schema: type: string - name: functionName in: path description: Function name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/FunctionSecrets' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token : get: operationId: WebApps_GetFunctionsAdminTokenSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/stringApplicationJson' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys : post: operationId: WebApps_ListHostKeysSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HostKeys' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus : post: operationId: WebApps_ListSyncStatusSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync : post: operationId: WebApps_SyncFunctionsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings : get: operationId: WebApps_ListHostNameBindingsSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HostNameBindingCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName} : get: operationId: WebApps_GetHostNameBindingSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: hostName in: path description: Hostname in the hostname binding. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HostNameBinding' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateHostNameBindingSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: hostName in: path description: Hostname in the hostname binding. required: true schema: type: string responses: '200': description: Resource 'HostNameBinding' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/HostNameBinding' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/HostNameBinding' description: Binding details. This is the JSON representation of a HostNameBinding object. required: true delete: operationId: WebApps_DeleteHostNameBindingSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: hostName in: path description: Hostname in the hostname binding. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} : get: operationId: WebApps_GetHybridConnectionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: The name of the slot for the web app. required: true schema: type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true schema: type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HybridConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateHybridConnectionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: The name of the slot for the web app. required: true schema: type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true schema: type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true schema: type: string responses: '200': description: Resource 'HybridConnection' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/HybridConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/HybridConnection' description: The details of the hybrid connection. required: true patch: operationId: WebApps_UpdateHybridConnectionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: The name of the slot for the web app. required: true schema: type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true schema: type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HybridConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/HybridConnection' description: The details of the hybrid connection. required: true delete: operationId: WebApps_DeleteHybridConnectionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: The name of the slot for the web app. required: true schema: type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true schema: type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays : get: operationId: WebApps_ListHybridConnectionsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/HybridConnection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection : get: operationId: WebApps_ListRelayServiceConnectionsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName} : get: operationId: WebApps_GetRelayServiceConnectionSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: entityName in: path description: Name of the hybrid connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateRelayServiceConnectionSlot tags: - Web Apps summary: Creates a new hybrid connection configuration (PUT), or updates an existing one… 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 schema: 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 schema: type: string - name: entityName in: path description: Name of the hybrid connection. required: true schema: type: string responses: '200': description: Resource 'RelayServiceConnectionEntity' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' description: Details of the hybrid connection configuration. required: true patch: operationId: WebApps_UpdateRelayServiceConnectionSlot tags: - Web Apps summary: Creates a new hybrid connection configuration (PUT), or updates an existing one… 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 schema: 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 schema: type: string - name: entityName in: path description: Name of the hybrid connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/RelayServiceConnectionEntity' description: Details of the hybrid connection configuration. required: true delete: operationId: WebApps_DeleteRelayServiceConnectionSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: entityName in: path description: Name of the hybrid connection. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances : get: operationId: WebApps_ListInstanceIdentifiersSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebAppInstanceStatusCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId} : get: operationId: WebApps_GetInstanceInfoSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: instanceId in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebSiteInstanceStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of web app slot. If not specified then will default to production slot. required: true schema: type: string - name: instanceId in: path description: ID of web app instance. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MSDeployStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateInstanceMSDeployOperationSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of web app slot. If not specified then will default to production slot. required: true schema: type: string - name: instanceId in: path description: ID of web app instance. required: true schema: type: string responses: '201': description: Resource 'MSDeployStatus' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/MSDeployStatus' '409': description: The request conflicts with the current state of the server. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/MSDeployStatus' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/MSDeploy' description: Details of MSDeploy operation required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log : get: operationId: WebApps_GetInstanceMSDeployLogSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of web app slot. If not specified then will default to production slot. required: true schema: type: string - name: instanceId in: path description: ID of web app instance. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MSDeployLog' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes : get: operationId: WebApps_ListInstanceProcessesSlot tags: - Web Apps summary: Get list of processes for a web site, or a deployment slot, or for a specific… 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 schema: 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Get process information by its ID for a specific scaled-out instance in a web… 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 schema: 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' delete: operationId: WebApps_DeleteInstanceProcessSlot tags: - Web Apps summary: Terminate a process by its ID for a web site, or a deployment slot, or specific… 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 schema: 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump : get: operationId: WebApps_GetInstanceProcessDumpSlot tags: - Web Apps summary: Get a memory dump of a process by its ID for a specific scaled-out instance in… description: Description for Get a memory dump of 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 schema: 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: '*/*': schema: type: string format: binary application/json: schema: type: string format: binary '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: '*/*': schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules : get: operationId: WebApps_ListInstanceProcessModulesSlot tags: - Web Apps summary: List module information for a process by its ID for a specific scaled-out… 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 schema: 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessModuleInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Get process information by its ID for a specific scaled-out instance in a web… 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 schema: 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string - name: baseAddress in: path description: Module base address. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessModuleInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads : get: operationId: WebApps_ListInstanceProcessThreadsSlot tags: - Web Apps summary: List the threads in a process by its ID for a specific scaled-out instance in a… 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 schema: 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessThreadInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable : post: operationId: WebApps_IsCloneableSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteCloneability' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listWorkflowsConnections : post: operationId: WebApps_ListWorkflowsConnectionsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WorkflowEnvelope' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/BackupItemCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/FunctionSecrets' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status : get: operationId: WebApps_GetMigrateMySqlStatusSlot tags: - Web Apps summary: Returns the status of MySql in app migration, if one is active, and whether or… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/MigrateMySqlStatus' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork : get: operationId: WebApps_GetSwiftVirtualNetworkConnectionSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheckSlot tags: - Web Apps summary: Integrates this Web App with a Virtual Network. 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 schema: 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 schema: type: string responses: '200': description: Resource 'SwiftVirtualNetwork' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' description: Properties of the Virtual Network connection. See example. required: true patch: operationId: WebApps_UpdateSwiftVirtualNetworkConnectionWithCheckSlot tags: - Web Apps summary: Integrates this Web App with a Virtual Network. 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SwiftVirtualNetwork' description: Properties of the Virtual Network connection. See example. required: true delete: operationId: WebApps_DeleteSwiftVirtualNetworkSlot tags: - Web Apps 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 schema: 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view} : get: operationId: WebApps_ListNetworkFeaturesSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: view in: path description: The type of view. Only "summary" is supported at this time. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/NetworkFeatures' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start : post: operationId: WebApps_StartWebSiteNetworkTraceSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. required: false schema: type: integer format: int32 - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). required: false schema: type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. required: false schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/stringApplicationJson' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/startOperation : post: operationId: WebApps_StartWebSiteNetworkTraceOperationSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. required: false schema: type: integer format: int32 - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). required: false schema: type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. required: false schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' '202': description: Azure operation completed successfully. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Generates a new publishing password for an app (or deployment slot, if… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters : get: operationId: WebApps_ListPerfMonCountersSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PerfMonCounterCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging : get: operationId: WebApps_GetSitePhpErrorLogFlagSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SitePhpErrorLogFlag' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons : get: operationId: WebApps_ListPremierAddOnsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName} : get: operationId: WebApps_GetPremierAddOnSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: premierAddOnName in: path description: Add-on name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_AddPremierAddOnSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: premierAddOnName in: path description: Add-on name. required: true schema: type: string responses: '200': description: Resource 'PremierAddOn' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' description: A JSON representation of the edited premier add-on. required: true patch: operationId: WebApps_UpdatePremierAddOnSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: premierAddOnName in: path description: Add-on name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PremierAddOn' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PremierAddOnPatchResource' description: A JSON representation of the edited premier add-on. required: true delete: operationId: WebApps_DeletePremierAddOnSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: premierAddOnName in: path description: Add-on name. required: true schema: type: string responses: '200': description: Resource deleted successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks : get: operationId: WebApps_GetPrivateAccessSlot tags: - Web Apps summary: Gets data around private site access enablement and authorized Virtual Networks… 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 schema: type: string - name: slot in: path description: The name of the slot for the web app. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateAccess' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_PutPrivateAccessVnetSlot tags: - Web Apps summary: Sets data around private site access enablement and authorized Virtual Networks… 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 schema: type: string - name: slot in: path description: The name of the slot for the web app. required: true schema: type: string responses: '200': description: Resource 'PrivateAccess' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/PrivateAccess' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PrivateAccess' description: The information for the private access required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections : get: operationId: WebApps_GetPrivateEndpointConnectionListSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the site deployment slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointConnectionCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName} : get: operationId: WebApps_GetPrivateEndpointConnectionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the site deployment slot. required: true schema: type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get a private endpoint connection for a site.: $ref: ./examples/GetSitePrivateEndpointConnectionSlot.json put: operationId: WebApps_ApproveOrRejectPrivateEndpointConnectionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the site deployment slot. required: true schema: type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true schema: type: string responses: '200': description: Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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 requestBody: content: application/json: schema: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' required: true delete: operationId: WebApps_DeletePrivateEndpointConnectionSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the site deployment slot. required: true schema: type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: {} '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: {} '204': description: 'There is no content to send for this request, but the headers may be useful. ' content: application/json: schema: {} default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PrivateLinkResourcesWrapper' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Get list of processes for a web site, or a deployment slot, or for a specific… 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId} : get: operationId: WebApps_GetProcessSlot tags: - Web Apps summary: Get process information by its ID for a specific scaled-out instance in a web… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' delete: operationId: WebApps_DeleteProcessSlot tags: - Web Apps summary: Terminate a process by its ID for a web site, or a deployment slot, or specific… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump : get: operationId: WebApps_GetProcessDumpSlot tags: - Web Apps summary: Get a memory dump of a process by its ID for a specific scaled-out instance in… description: Description for Get a memory dump of 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: '*/*': schema: type: string format: binary application/json: schema: type: string format: binary '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: '*/*': schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules : get: operationId: WebApps_ListProcessModulesSlot tags: - Web Apps summary: List module information for a process by its ID for a specific scaled-out… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessModuleInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Get process information by its ID for a specific scaled-out instance in a web… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string - name: baseAddress in: path description: Module base address. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessModuleInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads : get: operationId: WebApps_ListProcessThreadsSlot tags: - Web Apps summary: List the threads in a process by its ID for a specific scaled-out instance in a… 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 schema: 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 schema: type: string - name: processId in: path description: PID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ProcessThreadInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates : get: operationId: WebApps_ListPublicCertificatesSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PublicCertificateCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName} : get: operationId: WebApps_GetPublicCertificateSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: publicCertificateName in: path description: Public certificate name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/PublicCertificate' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdatePublicCertificateSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: publicCertificateName in: path description: Public certificate name. required: true schema: type: string responses: '200': description: Resource 'PublicCertificate' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/PublicCertificate' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/PublicCertificate' description: Public certificate details. This is the JSON representation of a PublicCertificate object. required: true delete: operationId: WebApps_DeletePublicCertificateSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: publicCertificateName in: path description: Public certificate name. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml : post: operationId: WebApps_ListPublishingProfileXmlWithSecretsSlot tags: - Web Apps 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). parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter - name: name in: path description: Name of the app. required: true schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/xml: schema: type: string format: binary application/json: schema: type: string format: binary default: description: An unexpected error response. content: application/xml: schema: $ref: '#/components/schemas/DefaultErrorResponse' application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmPublishingProfileOptions' description: 'Specifies publishingProfileOptions for publishing profile. For example, use {" format": "FileZilla3"} to get a FileZilla publishing profile.' required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig : post: operationId: WebApps_ResetSlotConfigurationSlot tags: - Web Apps summary: Resets the configuration settings of the current slot if they were previously… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart : post: operationId: WebApps_RestartSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: 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 schema: 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 schema: type: boolean responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob : post: operationId: WebApps_RestoreFromBackupBlobSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/RestoreRequest' description: Information on restore request . required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp : post: operationId: WebApps_RestoreFromDeletedAppSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/DeletedAppRestoreRequest' description: Deleted web app restore information. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot : post: operationId: WebApps_RestoreSnapshotSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SnapshotRestoreRequest' description: Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers : get: operationId: WebApps_ListSiteContainersSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteContainerCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName} : get: operationId: WebApps_GetSiteContainerSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: containerName in: path description: Site Container Name required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/SiteContainer' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateSiteContainerSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: containerName in: path description: Site Container Name required: true schema: type: string pattern: (^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$) responses: '200': description: Resource 'SiteContainer' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteContainer' '201': description: Resource 'SiteContainer' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteContainer' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteContainer' description: Container Entity required: true delete: operationId: WebApps_DeleteSiteContainerSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: containerName in: path description: Site Container Name required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions : get: operationId: WebApps_ListSiteExtensionsSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteExtensionInfoCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId} : get: operationId: WebApps_GetSiteExtensionSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: siteExtensionId in: path description: Site extension name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteExtensionInfo' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_InstallSiteExtensionSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: siteExtensionId in: path description: Site extension name. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteExtensionInfo' '201': description: Resource 'SiteExtensionInfo' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/SiteExtensionInfo' '429': description: Client error x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: 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 schema: type: string - name: siteExtensionId in: path description: Site extension name. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs : post: operationId: WebApps_ListSlotDifferencesSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SlotDifferenceCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmSlotEntity' description: JSON object that contains the target slot name. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap : post: operationId: WebApps_SwapSlotSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmSlotEntity' description: JSON object that contains the target slot name. See example. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots : get: operationId: WebApps_ListSnapshotsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SnapshotCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr : get: operationId: WebApps_ListSnapshotsFromDRSecondarySlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SnapshotCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web : get: operationId: WebApps_GetSourceControlSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '201': description: Resource 'SiteSourceControl' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '202': description: The request has been accepted for processing, but processing has not yet completed. content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateSourceControlSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Resource 'SiteSourceControl' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '201': description: Resource 'SiteSourceControl' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/SiteSourceControl' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' description: JSON representation of a SiteSourceControl object. See example. required: true patch: operationId: WebApps_UpdateSourceControlSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '201': description: Resource 'SiteSourceControl' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '202': description: The request has been accepted for processing, but processing has not yet completed. content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' description: JSON representation of a SiteSourceControl object. See example. required: true delete: operationId: WebApps_DeleteSourceControlSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: additionalFlags in: query required: false schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start: post: operationId: WebApps_StartSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/startNetworkTrace : post: operationId: WebApps_StartNetworkTraceSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. required: false schema: type: integer format: int32 - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). required: false schema: type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. required: false schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' '202': description: Azure operation completed successfully. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stopNetworkTrace : post: operationId: WebApps_StopNetworkTraceSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers : post: operationId: WebApps_SyncFunctionTriggersSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs : get: operationId: WebApps_ListTriggeredWebJobsSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/TriggeredWebJobCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName} : get: operationId: WebApps_GetTriggeredWebJobSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/TriggeredWebJob' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' delete: operationId: WebApps_DeleteTriggeredWebJobSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history : get: operationId: WebApps_ListTriggeredWebJobHistorySlot tags: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/TriggeredJobHistoryCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string - name: id in: path description: History ID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/TriggeredJobHistory' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run : post: operationId: WebApps_RunTriggeredWebJobSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages : get: operationId: WebApps_ListUsagesSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmUsageQuotaCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections : get: operationId: WebApps_ListVnetConnectionsSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/VnetInfoResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName} : get: operationId: WebApps_GetVnetConnectionSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: vnetName in: path description: Name of the virtual network. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateVnetConnectionSlot tags: - Web Apps summary: Adds a Virtual Network connection to an app or slot (PUT) or updates the… 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 schema: 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 schema: type: string - name: vnetName in: path description: Name of the virtual network. required: true schema: type: string responses: '200': description: Resource 'VnetInfoResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' description: Properties of the Virtual Network connection. See example. required: true patch: operationId: WebApps_UpdateVnetConnectionSlot tags: - Web Apps summary: Adds a Virtual Network connection to an app or slot (PUT) or updates the… 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 schema: 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 schema: type: string - name: vnetName in: path description: Name of the virtual network. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' description: Properties of the Virtual Network connection. See example. required: true delete: operationId: WebApps_DeleteVnetConnectionSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: vnetName in: path description: Name of the virtual network. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} : get: operationId: WebApps_GetVnetConnectionGatewaySlot tags: - Web Apps 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 schema: 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 schema: type: string - name: vnetName in: path description: Name of the Virtual Network. required: true schema: type: string - name: gatewayName in: path description: Name of the gateway. Currently, the only supported string is "primary". required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/VnetGateway' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateVnetConnectionGatewaySlot tags: - Web Apps 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 schema: 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 schema: type: string - name: vnetName in: path description: Name of the Virtual Network. required: true schema: type: string - name: gatewayName in: path description: Name of the gateway. Currently, the only supported string is "primary". required: true schema: type: string responses: '200': description: Resource 'VnetGateway' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/VnetGateway' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/VnetGateway' description: The properties to update this gateway with. required: true patch: operationId: WebApps_UpdateVnetConnectionGatewaySlot tags: - Web Apps 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 schema: 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 schema: type: string - name: vnetName in: path description: Name of the Virtual Network. required: true schema: type: string - name: gatewayName in: path description: Name of the gateway. Currently, the only supported string is "primary". required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/VnetGateway' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/VnetGateway' description: The properties to update this gateway with. required: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs : get: operationId: WebApps_ListWebJobsSlot tags: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebJobCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName} : get: operationId: WebApps_GetWebJobSlot tags: - Web Apps 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 schema: 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 schema: type: string - name: webJobName in: path description: Name of the web job. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebJob' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows : get: operationId: WebApps_ListInstanceWorkflowsSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WorkflowEnvelopeCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. required: true schema: type: string - name: workflowName in: path description: Workflow name. required: true schema: type: string maxLength: 63 minLength: 3 pattern: ^[a-z][a-z0-9]*$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WorkflowEnvelope' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SlotDifferenceCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmSlotEntity' description: JSON object that contains the target slot name. See example. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap: post: operationId: WebApps_SwapSlotWithProduction tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. '202': description: Resource operation accepted. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CsmSlotEntity' description: JSON object that contains the target slot name. See example. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots: get: operationId: WebApps_ListSnapshots tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SnapshotCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr: get: operationId: WebApps_ListSnapshotsFromDRSecondary tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SnapshotCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web: get: operationId: WebApps_GetSourceControl tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '201': description: Resource 'SiteSourceControl' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '202': description: The request has been accepted for processing, but processing has not yet completed. content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateSourceControl tags: - Web Apps 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 schema: type: string responses: '200': description: Resource 'SiteSourceControl' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '201': description: Resource 'SiteSourceControl' create operation succeeded headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-long-running-operation-options: final-state-via: location final-state-schema: '#/definitions/SiteSourceControl' x-ms-long-running-operation: true requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' description: JSON representation of a SiteSourceControl object. See example. required: true patch: operationId: WebApps_UpdateSourceControl tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '201': description: Resource 'SiteSourceControl' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' '202': description: The request has been accepted for processing, but processing has not yet completed. content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SiteSourceControl' description: JSON representation of a SiteSourceControl object. See example. required: true delete: operationId: WebApps_DeleteSourceControl tags: - Web Apps 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 schema: type: string - name: additionalFlags in: query required: false schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start: post: operationId: WebApps_Start tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/startNetworkTrace: post: operationId: WebApps_StartNetworkTrace tags: - Web Apps 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 schema: type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. required: false schema: type: integer format: int32 - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). required: false schema: type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. required: false schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' '202': description: Azure operation completed successfully. headers: Location: description: The Location header contains the URL where the status of the long running operation can be checked. schema: type: string Retry-After: description: The Retry-After header can indicate how long the client should wait before polling the operation status. schema: type: integer format: int32 content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stopNetworkTrace: post: operationId: WebApps_StopNetworkTrace tags: - Web Apps 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers : post: operationId: WebApps_SyncFunctionTriggers tags: - Web Apps 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 schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs: get: operationId: WebApps_ListTriggeredWebJobs tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/TriggeredWebJobCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName} : get: operationId: WebApps_GetTriggeredWebJob tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/TriggeredWebJob' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' delete: operationId: WebApps_DeleteTriggeredWebJob tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history : get: operationId: WebApps_ListTriggeredWebJobHistory tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/TriggeredJobHistoryCollection' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id} : get: operationId: WebApps_GetTriggeredWebJobHistory tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: type: string - name: id in: path description: History ID. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/TriggeredJobHistory' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run : post: operationId: WebApps_RunTriggeredWebJob tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of Web Job. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/updatemachinekey: post: operationId: WebApps_UpdateMachineKey tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: {} default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/CsmUsageQuotaCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections : get: operationId: WebApps_ListVnetConnections tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/VnetInfoResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName} : get: operationId: WebApps_GetVnetConnection tags: - Web Apps 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 schema: type: string - name: vnetName in: path description: Name of the virtual network. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateVnetConnection tags: - Web Apps summary: Adds a Virtual Network connection to an app or slot (PUT) or updates the… 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 schema: type: string - name: vnetName in: path description: Name of the virtual network. required: true schema: type: string responses: '200': description: Resource 'VnetInfoResource' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' description: Properties of the Virtual Network connection. See example. required: true patch: operationId: WebApps_UpdateVnetConnection tags: - Web Apps summary: Adds a Virtual Network connection to an app or slot (PUT) or updates the… 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 schema: type: string - name: vnetName in: path description: Name of the virtual network. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/VnetInfoResource' description: Properties of the Virtual Network connection. See example. required: true delete: operationId: WebApps_DeleteVnetConnection tags: - Web Apps 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 schema: type: string - name: vnetName in: path description: Name of the virtual network. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} : get: operationId: WebApps_GetVnetConnectionGateway tags: - Web Apps 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 schema: type: string - name: vnetName in: path description: Name of the Virtual Network. required: true schema: type: string - name: gatewayName in: path description: Name of the gateway. Currently, the only supported string is "primary". required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/VnetGateway' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' put: operationId: WebApps_CreateOrUpdateVnetConnectionGateway tags: - Web Apps 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 schema: type: string - name: vnetName in: path description: Name of the Virtual Network. required: true schema: type: string - name: gatewayName in: path description: Name of the gateway. Currently, the only supported string is "primary". required: true schema: type: string responses: '200': description: Resource 'VnetGateway' update operation succeeded content: application/json: schema: $ref: '#/components/schemas/VnetGateway' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/VnetGateway' description: The properties to update this gateway with. required: true patch: operationId: WebApps_UpdateVnetConnectionGateway tags: - Web Apps 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 schema: type: string - name: vnetName in: path description: Name of the Virtual Network. required: true schema: type: string - name: gatewayName in: path description: Name of the gateway. Currently, the only supported string is "primary". required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/VnetGateway' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/VnetGateway' description: The properties to update this gateway with. required: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs: get: operationId: WebApps_ListWebJobs tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebJobCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName} : get: operationId: WebApps_GetWebJob tags: - Web Apps 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 schema: type: string - name: webJobName in: path description: Name of the web job. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WebJob' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows: get: operationId: WebApps_ListWorkflows tags: - Web Apps 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 schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WorkflowEnvelopeCollection' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: workflowName in: path description: Workflow name. required: true schema: type: string maxLength: 63 minLength: 3 pattern: ^[a-z][a-z0-9]*$ responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/WorkflowEnvelope' '404': description: The server cannot find the requested resource. x-ms-error-response: true default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: functionName in: path required: true schema: type: string - name: keyName in: path required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/KeyInfo' '201': description: Resource 'KeyInfo' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/KeyInfo' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/KeyInfo' description: The key to create or update required: true delete: operationId: WebApps_DeleteFunctionSecret tags: - Web Apps 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 schema: type: string - name: functionName in: path required: true schema: type: string - name: keyName in: path required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/host/default/{keyType}/{keyName} : put: operationId: WebApps_CreateOrUpdateHostSecret tags: - Web Apps 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 schema: type: string - name: keyType in: path description: The type of host key. required: true schema: type: string - name: keyName in: path description: The name of the key. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/KeyInfo' '201': description: Resource 'KeyInfo' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/KeyInfo' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/KeyInfo' description: The key to create or update required: true delete: operationId: WebApps_DeleteHostSecret tags: - Web Apps 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 schema: type: string - name: keyType in: path description: The type of host key. required: true schema: type: string - name: keyName in: path description: The name of the key. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/networkTrace/{operationId} : get: operationId: WebApps_GetNetworkTraces tags: - Web Apps summary: Gets a named operation for a network trace capturing (or deployment slot, if… 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 schema: type: string - name: operationId in: path description: GUID of the operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Gets a named operation for a network trace capturing (or deployment slot, if… 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 schema: type: string - name: operationId in: path description: GUID of the operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' '202': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Gets a named operation for a network trace capturing (or deployment slot, if… 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 schema: type: string - name: operationId in: path description: GUID of the operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Gets a named operation for a network trace capturing (or deployment slot, if… 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 schema: type: string - name: operationId in: path description: GUID of the operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' '202': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: keyType in: path description: The type of host key. required: true schema: type: string - name: keyName in: path description: The name of the key. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/KeyInfo' '201': description: Resource 'KeyInfo' create operation succeeded content: application/json: schema: $ref: '#/components/schemas/KeyInfo' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/KeyInfo' description: The key to create or update required: true delete: operationId: WebApps_DeleteHostSecretSlot tags: - Web Apps 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: keyType in: path description: The type of host key. required: true schema: type: string - name: keyName in: path description: The name of the key. required: true schema: 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. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId} : get: operationId: WebApps_GetNetworkTracesSlot tags: - Web Apps summary: Gets a named operation for a network trace capturing (or deployment slot, if… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: operationId in: path description: GUID of the operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Gets a named operation for a network trace capturing (or deployment slot, if… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: operationId in: path description: GUID of the operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' '202': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Gets a named operation for a network trace capturing (or deployment slot, if… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: operationId in: path description: GUID of the operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/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: - Web Apps summary: Gets a named operation for a network trace capturing (or deployment slot, if… 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 schema: type: string - name: slot in: path description: Name of the deployment slot. By default, this API returns the production slot. required: true schema: type: string - name: operationId in: path description: GUID of the operation. required: true schema: type: string responses: '200': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' '202': description: Azure operation completed successfully. content: application/json: schema: type: array items: $ref: '#/components/schemas/NetworkTrace' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/DefaultErrorResponse' x-ms-examples: Get the current status of a network trace operation for a site: $ref: ./examples/GetWebSiteNetworkTraceOperation_SlotV2.json components: schemas: MigrateMySqlRequestProperties: type: object description: MigrateMySqlRequest resource specific properties properties: connectionString: type: string description: Connection string to the remote MySQL database. migrationType: $ref: '#/components/schemas/MySqlMigrationType' description: The type of migration operation to be done required: - connectionString - migrationType 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 ConnStringValueTypePair: type: object description: Database connection string value to type pair. properties: value: type: string description: Value of pair. type: $ref: '#/components/schemas/ConnectionStringType' description: Type of database. required: - value - type 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.' 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 HttpLogsConfig: type: object description: Http logs configuration. properties: fileSystem: $ref: '#/components/schemas/FileSystemHttpLogsConfig' description: Http logs to file system configuration. azureBlobStorage: $ref: '#/components/schemas/AzureBlobStorageHttpLogsConfig' description: Http logs to azure blob storage configuration. SiteAuthSettingsV2: type: object description: Configuration settings for the Azure App Service Authentication / Authorization V2 feature. properties: properties: $ref: '#/components/schemas/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 AutoHealActions: type: object description: Actions which to take by the auto-heal module when a rule is triggered. properties: actionType: $ref: '#/components/schemas/AutoHealActionType' description: Predefined action to be taken. customAction: $ref: '#/components/schemas/AutoHealCustomAction' description: Custom action to be taken. minProcessExecutionTime: type: string description: 'Minimum time the process must execute before taking the action' 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: '#/components/schemas/OpenIdConnectRegistration' description: The configuration settings of the app registration for the custom Open ID Connect provider. login: $ref: '#/components/schemas/OpenIdConnectLogin' description: The configuration settings of the login flow of the custom Open ID Connect provider. MSDeployLogEntry: type: object description: MSDeploy log entry properties: time: type: string format: date-time description: Timestamp of log entry readOnly: true type: $ref: '#/components/schemas/MSDeployLogEntryType' description: Log entry type readOnly: true message: type: string description: Log entry message readOnly: true AzureStorageType: type: string description: Type of storage. enum: - AzureFiles - AzureBlob x-ms-enum: name: AzureStorageType modelAsString: false 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: '#/components/schemas/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 WebJob: type: object description: Web Job Information. properties: properties: $ref: '#/components/schemas/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 SslState: type: string description: SSL type enum: - Disabled - SniEnabled - IpBasedEnabled x-ms-enum: name: SslState modelAsString: false SiteLogsConfig: type: object description: Configuration of App Service site logs. properties: properties: $ref: '#/components/schemas/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 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.' SiteExtensionInfoCollection: type: object description: Collection of Kudu site extension information elements. properties: value: type: array description: The SiteExtensionInfo items on this page items: $ref: '#/components/schemas/SiteExtensionInfo' nextLink: type: string format: uri description: The link to the next page of items required: - value MigrateMySqlStatus: type: object description: MySQL migration status. properties: properties: $ref: '#/components/schemas/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 WebSiteInstanceStatusProperties: type: object description: WebSiteInstanceStatus resource specific properties properties: state: $ref: '#/components/schemas/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: '#/components/schemas/ContainerInfo' physicalZone: type: string description: The physical zone that the instance is in AzureActiveDirectoryValidation: type: object description: The configuration settings of the Azure Active Directory token validation flow. properties: jwtClaimChecks: $ref: '#/components/schemas/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: '#/components/schemas/DefaultAuthorizationPolicy' description: The configuration settings of the default authorization policy. 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 MSDeploy: type: object description: MSDeploy ARM PUT information properties: properties: $ref: '#/components/schemas/MSDeployProperties' description: Core resource properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' ProcessThreadInfoCollection: type: object description: Collection of Kudu thread information elements. properties: value: type: array description: The ProcessThreadInfo items on this page items: $ref: '#/components/schemas/ProcessThreadInfo' nextLink: type: string format: uri description: The link to the next page of items required: - value 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: '#/components/schemas/TriggeredWebJob' nextLink: type: string format: uri description: The link to the next page of items required: - value 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: '#/components/schemas/GitHubActionConfiguration' description: If GitHub Action is selected, than the associated configuration. 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. AutoHealRules: type: object description: Rules that can be defined for auto-heal. properties: triggers: $ref: '#/components/schemas/AutoHealTriggers' description: Conditions that describe when to execute the auto-heal actions. actions: $ref: '#/components/schemas/AutoHealActions' description: Actions to be executed when a rule is triggered. 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. 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: '#/components/schemas/ConnectionStringType' description: Type of database. Login: type: object description: The configuration settings of the login flow of users using App Service Authentication/Authorization. properties: routes: $ref: '#/components/schemas/LoginRoutes' description: The routes that specify the endpoints used for login and logout requests. tokenStore: $ref: '#/components/schemas/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: '#/components/schemas/CookieExpiration' description: The configuration settings of the session cookie's expiration. nonce: $ref: '#/components/schemas/Nonce' description: The configuration settings of the nonce used in the login flow. SlotDifferenceCollection: type: object description: Collection of slot differences. properties: value: type: array description: The SlotDifference items on this page items: $ref: '#/components/schemas/SlotDifference' nextLink: type: string format: uri description: The link to the next page of items required: - value PremierAddOnPatchResource: type: object description: ARM resource for a PremierAddOn. properties: properties: $ref: '#/components/schemas/PremierAddOnPatchResourceProperties' description: PremierAddOnPatchResource resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' MSDeployStatusProperties: type: object description: MSDeployStatus resource specific properties properties: deployer: type: string description: Username of deployer readOnly: true provisioningState: $ref: '#/components/schemas/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 ArmIdWrapper: type: object description: A wrapper for an ARM resource id properties: id: type: string 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. ApplicationLogsConfig: type: object description: Application logs configuration. properties: fileSystem: $ref: '#/components/schemas/FileSystemApplicationLogsConfig' description: Application logs to file system configuration. azureTableStorage: $ref: '#/components/schemas/AzureTableStorageApplicationLogsConfig' description: Application logs to azure table storage configuration. azureBlobStorage: $ref: '#/components/schemas/AzureBlobStorageApplicationLogsConfig' description: Application logs to blob storage configuration. 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 StringDictionary: type: object description: String dictionary resource. properties: properties: type: object description: Settings. additionalProperties: type: string x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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. 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: '#/components/schemas/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 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. 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 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: '#/components/schemas/TwitterRegistration' description: The configuration settings of the app registration for the Twitter provider. PrivateAccess: type: object description: Description of the parameters of Private Access for a Web Site. properties: properties: $ref: '#/components/schemas/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 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 LogLevel: type: string description: Log level. enum: - 'Off' - Verbose - Information - Warning - Error x-ms-enum: name: LogLevel modelAsString: false AutoHealTriggers: type: object description: Triggers for auto-heal. properties: requests: $ref: '#/components/schemas/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: '#/components/schemas/StatusCodesBasedTrigger' x-ms-identifiers: - path slowRequests: $ref: '#/components/schemas/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: '#/components/schemas/SlowRequestsBasedTrigger' x-ms-identifiers: - path statusCodesRange: type: array description: A rule based on status codes ranges. items: $ref: '#/components/schemas/StatusCodesRangeBasedTrigger' x-ms-identifiers: - path Site: type: object description: A web app, a mobile app backend, or an API app. properties: properties: $ref: '#/components/schemas/SiteProperties' description: Site resource specific properties x-ms-client-flatten: true identity: $ref: '#/components/schemas/ManagedServiceIdentity' description: Managed service identity. extendedLocation: $ref: '#/components/schemas/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 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 FunctionsScaleAndConcurrencyTriggers: type: object description: Scale and concurrency settings for the function app triggers. properties: http: $ref: '#/components/schemas/FunctionsScaleAndConcurrencyTriggersHttp' description: Scale and concurrency settings for the HTTP trigger. PushSettings: type: object description: Push settings for the App. properties: properties: $ref: '#/components/schemas/PushSettingsProperties' description: PushSettings resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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 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: '#/components/schemas/HttpSettingsRoutes' description: The configuration settings of the paths HTTP requests. forwardProxy: $ref: '#/components/schemas/ForwardProxy' description: The configuration settings of a forward proxy used to make the requests. 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 FunctionsDeploymentStorage: type: object description: Storage for deployed package used by the function app. properties: type: $ref: '#/components/schemas/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: '#/components/schemas/FunctionsDeploymentStorageAuthentication' description: Authentication method to access the storage account for deployment. CloneAbilityResult: type: string description: Name of app. enum: - Cloneable - PartiallyCloneable - NotCloneable x-ms-enum: name: CloneAbilityResult modelAsString: false 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 SiteAuthSettings: type: object description: Configuration settings for the Azure App Service Authentication / Authorization feature. properties: properties: $ref: '#/components/schemas/SiteAuthSettingsProperties' description: SiteAuthSettings resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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 FunctionsDeployment: type: object description: Configuration section for the function app deployment. properties: storage: $ref: '#/components/schemas/FunctionsDeploymentStorage' description: Storage for deployed package used by the function app. 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.' BackupItemStatus: type: string description: Backup status. enum: - InProgress - Failed - Succeeded - TimedOut - Created - Skipped - PartiallySucceeded - DeleteInProgress - DeleteFailed - Deleted x-ms-enum: name: BackupItemStatus modelAsString: false 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 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. 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 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. 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 SiteExtensionInfo: type: object description: Site Extension Information. properties: properties: $ref: '#/components/schemas/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 ProcessThreadInfo: type: object description: Process Thread Information. properties: properties: $ref: '#/components/schemas/ProcessThreadInfoProperties' description: ProcessThreadInfo resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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. TriggeredWebJobProperties: type: object description: TriggeredWebJob resource specific properties properties: latest_run: $ref: '#/components/schemas/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: '#/components/schemas/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: {} 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: '#/components/schemas/PrivateAccessVirtualNetwork' x-ms-identifiers: - key FunctionEnvelopeCollection: type: object description: Collection of Kudu function information elements. properties: value: type: array description: The FunctionEnvelope items on this page items: $ref: '#/components/schemas/FunctionEnvelope' nextLink: type: string format: uri description: The link to the next page of items required: - value 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.' 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.' 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: '#/components/schemas/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: '#/components/schemas/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.' 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. BackupItem: type: object description: Backup description. properties: properties: $ref: '#/components/schemas/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 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. ContinuousWebJobStatus: type: string description: Job status. enum: - Initializing - Starting - Running - PendingRestart - Stopped x-ms-enum: name: ContinuousWebJobStatus modelAsString: false WorkflowHealth: type: object description: Represents the workflow health. properties: state: $ref: '#/components/schemas/WorkflowHealthState' description: Gets or sets the workflow health state. error: $ref: '#/components/schemas/ErrorEntity' description: Gets or sets the workflow error. required: - state 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. ProcessInfoCollection: type: object description: Collection of Kudu process information elements. properties: value: type: array description: The ProcessInfo items on this page items: $ref: '#/components/schemas/ProcessInfo' nextLink: type: string format: uri description: The link to the next page of items required: - value PrivateLinkResourcesWrapper: type: object description: Wrapper for a collection of private link resources properties: value: type: array items: $ref: '#/components/schemas/PrivateLinkResource' required: - value ContainerCpuStatistics: type: object properties: cpuUsage: $ref: '#/components/schemas/ContainerCpuUsage' systemCpuUsage: type: integer format: int64 onlineCpuCount: type: integer format: int32 throttlingData: $ref: '#/components/schemas/ContainerThrottlingData' PublishingCredentialsPoliciesCollection: type: object description: Publishing Credentials Policies entity collection ARM resource. properties: value: type: array description: The CsmPublishingCredentialsPoliciesEntity items on this page items: $ref: '#/components/schemas/CsmPublishingCredentialsPoliciesEntity' nextLink: type: string format: uri description: The link to the next page of items required: - value SiteCloneability: type: object description: Represents whether or not an app is cloneable. properties: result: $ref: '#/components/schemas/CloneAbilityResult' description: Name of app. blockingFeatures: type: array description: List of features enabled on app that prevent cloning. items: $ref: '#/components/schemas/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: '#/components/schemas/SiteCloneabilityCriterion' x-ms-identifiers: - name blockingCharacteristics: type: array description: List of blocking application characteristics. items: $ref: '#/components/schemas/SiteCloneabilityCriterion' x-ms-identifiers: - name WebSiteInstanceStatus: type: object description: Concrete proxy resource types can be created by aliasing this type using a specific property type. properties: properties: $ref: '#/components/schemas/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 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 MigrateMySqlRequest: type: object description: MySQL migration request. properties: properties: $ref: '#/components/schemas/MigrateMySqlRequestProperties' description: MigrateMySqlRequest resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' CookieExpiration: type: object description: The configuration settings of the session cookie's expiration. properties: convention: $ref: '#/components/schemas/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. IdentifierCollection: type: object description: Collection of identifiers. properties: value: type: array description: The Identifier items on this page items: $ref: '#/components/schemas/Identifier' nextLink: type: string format: uri description: The link to the next page of items required: - value ResolveStatus: type: string enum: - Initialized - Resolved - InvalidSyntax - MSINotEnabled - VaultNotFound - SecretNotFound - SecretVersionNotFound - AccessToKeyVaultDenied - OtherReasons - FetchTimedOut - UnauthorizedClient x-ms-enum: name: ResolveStatus modelAsString: false DefaultAction: type: string description: Default action for main access restriction if no rules are matched. enum: - Allow - Deny x-ms-enum: name: DefaultAction modelAsString: true values: - name: Allow value: Allow - name: Deny value: Deny MSDeployLog: type: object description: MSDeploy log properties: properties: $ref: '#/components/schemas/MSDeployLogProperties' description: MSDeployLog resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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 AzureBlobStorageApplicationLogsConfig: type: object description: Application logs azure blob storage configuration. properties: level: $ref: '#/components/schemas/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.' 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 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: '#/components/schemas/ErrorEntity' x-ms-identifiers: [] details: type: array description: Error Details. items: $ref: '#/components/schemas/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. SiteSourceControl: type: object description: Source control configuration for an app. properties: properties: $ref: '#/components/schemas/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 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: '#/components/schemas/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 AzureStorageState: type: string description: State of the storage account. enum: - Ok - InvalidCredentials - InvalidShare - NotValidated x-ms-enum: name: AzureStorageState modelAsString: false AzureStaticWebApps: type: object description: The configuration settings of the Azure Static Web Apps provider. properties: enabled: type: boolean description: false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. registration: $ref: '#/components/schemas/AzureStaticWebAppsRegistration' description: The configuration settings of the Azure Static Web Apps registration. 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: '#/components/schemas/FileSystemTokenStore' description: The configuration settings of the storage of the tokens if a file system is used. azureBlobStorage: $ref: '#/components/schemas/BlobStorageTokenStore' description: The configuration settings of the storage of the tokens if blob storage is used. SiteAvailabilityState: type: string description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode x-ms-enum: name: SiteAvailabilityState modelAsString: false PerfMonCounterCollection: type: object description: Collection of performance monitor counters. properties: value: type: array description: The PerfMonResponse items on this page items: $ref: '#/components/schemas/PerfMonResponse' nextLink: type: string format: uri description: The link to the next page of items required: - value 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: '#/components/schemas/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 MSDeployProvisioningState: type: string description: Provisioning state enum: - accepted - running - succeeded - failed - canceled x-ms-enum: name: MSDeployProvisioningState modelAsString: false 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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/SiteDnsConfig' description: Property to configure various DNS related settings for a site. outboundVnetRouting: $ref: '#/components/schemas/OutboundVnetRouting' description: Property to configure various outbound traffic routing options over virtual network for a site siteConfig: $ref: '#/components/schemas/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: '#/components/schemas/FunctionAppConfig' description: Configuration specific of the Azure Function app. daprConfig: $ref: '#/components/schemas/DaprConfig' description: Dapr configuration of the app. workloadProfileName: type: string description: Workload profile name for function app to execute on. resourceConfig: $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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 CsmDeploymentStatusProperties: type: object description: CsmDeploymentStatus resource specific properties properties: deploymentId: type: string description: Deployment operation id. status: $ref: '#/components/schemas/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: '#/components/schemas/ErrorEntity' x-ms-identifiers: [] StorageMigrationResponse: type: object description: Response for a migration of app content request. properties: properties: $ref: '#/components/schemas/StorageMigrationResponseProperties' description: StorageMigrationResponse resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/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: '#/components/schemas/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 PerfMonResponse: type: object description: Performance monitor API response. properties: code: type: string description: The response code. message: type: string description: The message. data: $ref: '#/components/schemas/PerfMonSet' description: The performance monitor counters. HostNameSslState: type: object description: SSL-enabled hostname. properties: name: type: string description: Hostname. sslState: $ref: '#/components/schemas/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: '#/components/schemas/HostType' description: Indicates whether the hostname is a standard or repository hostname. 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 CsmDeploymentStatus: type: object description: Deployment status response payload. properties: properties: $ref: '#/components/schemas/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 ApiDefinitionInfo: type: object description: Information about the formal API definition for the app. properties: url: type: string description: The URL of the API definition. 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 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: '#/components/schemas/ClientRegistration' description: The configuration settings of the app registration for the GitHub provider. login: $ref: '#/components/schemas/LoginScopes' description: The configuration settings of the login flow. OperationStatus: type: string description: The current status of the operation. enum: - InProgress - Failed - Succeeded - TimedOut - Created x-ms-enum: name: OperationStatus modelAsString: false 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. 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: '#/components/schemas/SiteConfigurationSnapshotInfo' nextLink: type: string format: uri description: The link to the next page of items required: - value 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 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 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: '#/components/schemas/VirtualDirectory' x-ms-identifiers: - virtualPath MigrateMySqlStatusProperties: type: object description: MigrateMySqlStatus resource specific properties properties: migrationOperationStatus: $ref: '#/components/schemas/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 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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/ConnStringInfo' x-ms-identifiers: - name x-ms-mutability: - update - create machineKey: $ref: '#/components/schemas/SiteMachineKey' description: Site MachineKey. readOnly: true handlerMappings: type: array description: Handler mappings. items: $ref: '#/components/schemas/HandlerMapping' x-ms-identifiers: - extension documentRoot: type: string description: Document root. scmType: $ref: '#/components/schemas/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: '#/components/schemas/ManagedPipelineMode' description: Managed pipeline mode. virtualApplications: type: array description: Virtual applications. items: $ref: '#/components/schemas/VirtualApplication' x-ms-identifiers: - virtualPath loadBalancing: $ref: '#/components/schemas/SiteLoadBalancing' description: Site load balancing. experiments: $ref: '#/components/schemas/Experiments' description: This is work around for polymorphic types. limits: $ref: '#/components/schemas/SiteLimits' description: Site limits. autoHealEnabled: type: boolean description: true if Auto Heal is enabled; otherwise, false. autoHealRules: $ref: '#/components/schemas/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: '#/components/schemas/CorsSettings' description: Cross-Origin Resource Sharing (CORS) settings. push: $ref: '#/components/schemas/PushSettings' description: Push endpoint settings. apiDefinition: $ref: '#/components/schemas/ApiDefinitionInfo' description: Information about the formal API definition for the app. apiManagementConfig: $ref: '#/components/schemas/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: '#/components/schemas/IpSecurityRestriction' x-ms-identifiers: - name ipSecurityRestrictionsDefaultAction: $ref: '#/components/schemas/DefaultAction' description: Default action for main access restriction if no rules are matched. scmIpSecurityRestrictions: type: array description: IP security restrictions for scm. items: $ref: '#/components/schemas/IpSecurityRestriction' x-ms-identifiers: - name scmIpSecurityRestrictionsDefaultAction: $ref: '#/components/schemas/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: '#/components/schemas/SupportedTlsVersions' description: 'MinTlsVersion: configures the minimum version of TLS required for SSL requests' minTlsCipherSuite: $ref: '#/components/schemas/TlsCipherSuites' description: The minimum strength TLS cipher suite allowed for an application scmMinTlsVersion: $ref: '#/components/schemas/SupportedTlsVersions' description: 'ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site' ftpsState: $ref: '#/components/schemas/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: '#/components/schemas/AzureStorageInfoValue' publicNetworkAccess: type: string description: Property to allow or block all public traffic. VnetInfoResource: type: object description: Virtual Network information ARM resource. properties: properties: $ref: '#/components/schemas/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 RequestsBasedTrigger: type: object description: Trigger based on total requests. properties: count: type: integer format: int32 description: Request Count. timeInterval: type: string description: Time interval. CookieExpirationConvention: type: string description: The convention used when determining the session cookie's expiration. enum: - FixedTime - IdentityProviderDerived x-ms-enum: name: CookieExpirationConvention modelAsString: false GitHubActionConfiguration: type: object description: The GitHub action configuration. properties: codeConfiguration: $ref: '#/components/schemas/GitHubActionCodeConfiguration' description: GitHub Action code configuration. containerConfiguration: $ref: '#/components/schemas/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. SiteCloneabilityCriterion: type: object description: An app cloneability criterion. properties: name: type: string description: Name of criterion. description: type: string description: Description of criterion. 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: '#/components/schemas/Snapshot' nextLink: type: string format: uri description: The link to the next page of items required: - value 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. IPMode: type: string description: Specifies the IP mode of the app. enum: - IPv4 - IPv6 - IPv4AndIPv6 x-ms-enum: name: IPMode 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. SiteLogsConfigProperties: type: object description: SiteLogsConfig resource specific properties properties: applicationLogs: $ref: '#/components/schemas/ApplicationLogsConfig' description: Application logs configuration. httpLogs: $ref: '#/components/schemas/HttpLogsConfig' description: HTTP logs configuration. failedRequestsTracing: $ref: '#/components/schemas/EnabledConfig' description: Failed requests tracing configuration. detailedErrorMessages: $ref: '#/components/schemas/EnabledConfig' description: Detailed error messages configuration. 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 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. StorageMigrationOptions: type: object description: Options for app content migration. properties: properties: $ref: '#/components/schemas/StorageMigrationOptionsProperties' description: StorageMigrationOptions resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/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 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: '#/components/schemas/DefaultErrorResponseErrorDetailsItem' x-ms-identifiers: [] innererror: type: string description: More information to debug error. readOnly: true DefaultAuthorizationPolicy: type: object description: The configuration settings of the Azure Active Directory default authorization policy. properties: allowedPrincipals: $ref: '#/components/schemas/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 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. 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. ApiKVReferenceProperties: type: object description: ApiKVReference resource specific properties properties: reference: type: string status: $ref: '#/components/schemas/ResolveStatus' vaultName: type: string secretName: type: string secretVersion: type: string identityType: $ref: '#/components/schemas/ManagedServiceIdentity' description: Managed service identity. details: type: string source: type: string enum: - KeyVault x-ms-enum: modelAsString: false activeVersion: type: string SlotDifference: type: object description: A setting difference between two deployment slots of an app. properties: properties: $ref: '#/components/schemas/SlotDifferenceProperties' description: SlotDifference resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' FunctionEnvelope: type: object description: Function information. properties: properties: $ref: '#/components/schemas/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 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. TriggeredWebJobStatus: type: string description: Job status. enum: - Success - Failed - Error x-ms-enum: name: TriggeredWebJobStatus modelAsString: false 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 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. 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. TriggeredWebJob: type: object description: Triggered Web Job Information. properties: properties: $ref: '#/components/schemas/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 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: '#/components/schemas/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. 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 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: '#/components/schemas/MSDeployCore' x-ms-identifiers: - packageUri allOf: - $ref: '#/components/schemas/MSDeployCore' 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 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. 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 FunctionAppConfig: type: object description: Function app configuration. properties: deployment: $ref: '#/components/schemas/FunctionsDeployment' description: Function app deployment configuration. runtime: $ref: '#/components/schemas/FunctionsRuntime' description: Function app runtime settings. scaleAndConcurrency: $ref: '#/components/schemas/FunctionsScaleAndConcurrency' description: Function app scale and concurrency settings. siteUpdateStrategy: $ref: '#/components/schemas/FunctionsSiteUpdateStrategy' description: Function app site update strategy configuration. 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. 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. 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 SiteConfigResourceCollection: type: object description: Collection of site configurations. properties: value: type: array description: The SiteConfigResource items on this page items: $ref: '#/components/schemas/SiteConfigResource' nextLink: type: string format: uri description: The link to the next page of items required: - value ManagedPipelineMode: type: string description: Managed pipeline mode. enum: - Integrated - Classic x-ms-enum: name: ManagedPipelineMode modelAsString: false 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: '#/components/schemas/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: '#/components/schemas/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 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: '#/components/schemas/PrivateLinkResourceProperties' description: Properties of a private link resource required: - id - name - type - properties 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 MySqlMigrationType: type: string description: The type of migration operation to be done enum: - LocalToRemote - RemoteToLocal x-ms-enum: name: MySqlMigrationType modelAsString: false ApiManagementConfig: type: object description: Azure API management (APIM) configuration linked to the app. properties: id: type: string description: APIM-Api Identifier. SitePhpErrorLogFlag: type: object description: Used for getting PHP error logging flag. properties: properties: $ref: '#/components/schemas/SitePhpErrorLogFlagProperties' description: SitePhpErrorLogFlag resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' Deployment: type: object description: User credentials used for publishing activity. properties: properties: $ref: '#/components/schemas/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 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 SiteAuthSettingsV2Properties: type: object description: SiteAuthSettingsV2 resource specific properties properties: platform: $ref: '#/components/schemas/AuthPlatform' description: The configuration settings of the platform of App Service Authentication/Authorization. globalValidation: $ref: '#/components/schemas/GlobalValidation' description: The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. identityProviders: $ref: '#/components/schemas/IdentityProviders' description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. login: $ref: '#/components/schemas/Login' description: The configuration settings of the login flow of users using App Service Authentication/Authorization. httpSettings: $ref: '#/components/schemas/HttpSettings' description: The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. 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. MSDeployLogProperties: type: object description: MSDeployLog resource specific properties properties: entries: type: array description: List of log entry messages items: $ref: '#/components/schemas/MSDeployLogEntry' readOnly: true x-ms-identifiers: [] 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: '#/components/schemas/PerfMonSample' x-ms-identifiers: [] HostNameType: type: string description: Hostname type. enum: - Verified - Managed x-ms-enum: name: HostNameType modelAsString: false 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. 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 HostNameBindingCollection: type: object description: Collection of hostname bindings. properties: value: type: array description: The HostNameBinding items on this page items: $ref: '#/components/schemas/HostNameBinding' nextLink: type: string format: uri description: The link to the next page of items required: - value DeletedAppRestoreRequest: type: object description: Details about restoring a deleted app. properties: properties: $ref: '#/components/schemas/DeletedAppRestoreRequestProperties' description: DeletedAppRestoreRequest resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' AuthType: type: string description: Auth Type enum: - Anonymous - UserCredentials - SystemIdentity - UserAssigned x-ms-enum: name: AuthType modelAsString: false stringApplicationJson: type: string ContainerThrottlingData: type: object properties: periods: type: integer format: int32 throttledPeriods: type: integer format: int32 throttledTime: type: integer format: int32 ForwardProxy: type: object description: The configuration settings of a forward proxy used to make the requests. properties: convention: $ref: '#/components/schemas/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. PublicCertificateCollection: type: object description: Collection of public certificates properties: value: type: array description: The PublicCertificate items on this page items: $ref: '#/components/schemas/PublicCertificate' nextLink: type: string format: uri description: The link to the next page of items required: - value 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: '#/components/schemas/BackupSchedule' description: Schedule for the backup if it is executed periodically. databases: type: array description: Databases included in the backup. items: $ref: '#/components/schemas/DatabaseBackupSetting' x-ms-identifiers: - name required: - storageAccountUrl FunctionsRuntime: type: object description: Function app runtime name and version. properties: name: $ref: '#/components/schemas/RuntimeName' description: 'Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom' version: type: - string - 'null' description: 'Function app runtime version. Example: 8 (for dotnet-isolated)' DefaultErrorResponse: type: object description: App Service error response. properties: error: $ref: '#/components/schemas/DefaultErrorResponseError' description: Error model. readOnly: true DatabaseBackupSetting: type: object description: Database backup settings. properties: databaseType: $ref: '#/components/schemas/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 WebAppCollection: type: object description: Collection of App Service apps. properties: value: type: array description: The Site items on this page items: $ref: '#/components/schemas/Site' nextLink: type: string format: uri description: The link to the next page of items required: - value NetworkFeatures: type: object description: Full view of network features for an app (presently VNET integration and Hybrid Connections). properties: properties: $ref: '#/components/schemas/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 AzureTableStorageApplicationLogsConfig: type: object description: Application logs to Azure table storage configuration. properties: level: $ref: '#/components/schemas/LogLevel' description: Log level. sasUrl: type: string description: SAS URL to an Azure table with add/query/delete permissions. required: - sasUrl VnetRoute: type: object description: Virtual Network route contract used to pass routing information for a Virtual Network. properties: properties: $ref: '#/components/schemas/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 IdentityProviders: type: object description: The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. properties: azureActiveDirectory: $ref: '#/components/schemas/AzureActiveDirectory' description: The configuration settings of the Azure Active directory provider. facebook: $ref: '#/components/schemas/Facebook' description: The configuration settings of the Facebook provider. gitHub: $ref: '#/components/schemas/GitHub' description: The configuration settings of the GitHub provider. google: $ref: '#/components/schemas/Google' description: The configuration settings of the Google provider. legacyMicrosoftAccount: $ref: '#/components/schemas/LegacyMicrosoftAccount' description: The configuration settings of the legacy Microsoft Account provider. twitter: $ref: '#/components/schemas/Twitter' description: The configuration settings of the Twitter provider. apple: $ref: '#/components/schemas/Apple' description: The configuration settings of the Apple provider. azureStaticWebApps: $ref: '#/components/schemas/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: '#/components/schemas/CustomOpenIdConnectProvider' PublicCertificateLocation: type: string description: Public Certificate Location enum: - CurrentUserMy - LocalMachineMy - Unknown x-ms-enum: name: PublicCertificateLocation modelAsString: false FunctionsDeploymentStorageAuthentication: type: object description: Authentication method to access the storage account for deployment. properties: type: $ref: '#/components/schemas/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. 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 BackupItemCollection: type: object description: Collection of backup items. properties: value: type: array description: The BackupItem items on this page items: $ref: '#/components/schemas/BackupItem' nextLink: type: string format: uri description: The link to the next page of items required: - value 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: '#/components/schemas/TriggeredJobHistory' nextLink: type: string format: uri description: The link to the next page of items required: - value RemotePrivateEndpointConnectionARMResourceProperties: type: object description: RemotePrivateEndpointConnectionARMResource resource specific properties properties: provisioningState: type: string readOnly: true privateEndpoint: $ref: '#/components/schemas/ArmIdWrapper' description: PrivateEndpoint of a remote private endpoint connection privateLinkServiceConnectionState: $ref: '#/components/schemas/PrivateLinkConnectionState' description: The state of a private link connection ipAddresses: type: array description: Private IPAddresses mapped to the remote private endpoint items: type: string CsmPublishingProfileOptions: type: object description: Publishing options for requested profile. properties: format: $ref: '#/components/schemas/PublishingProfileFormat' description: 'Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp' includeDisasterRecoveryEndpoints: type: boolean description: Include the DisasterRecover endpoint if true ProcessInfo: type: object description: Process Information. properties: properties: $ref: '#/components/schemas/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 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" 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 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 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: '#/components/schemas/DnsVerificationTestResult' description: DNS verification test result. readOnly: true customDomainVerificationFailureInfo: $ref: '#/components/schemas/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 DnsVerificationTestResult: type: string description: DNS verification test result. enum: - Passed - Failed - Skipped x-ms-enum: name: DnsVerificationTestResult modelAsString: false ApiKVReference: type: object description: Description of site key vault references. properties: properties: $ref: '#/components/schemas/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 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: '#/components/schemas/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: '#/components/schemas/LoginScopes' description: The configuration settings of the login flow. SiteContainer: type: object description: Container of a site properties: properties: $ref: '#/components/schemas/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 SnapshotRestoreRequest: type: object description: Details about app recovery operation. properties: properties: $ref: '#/components/schemas/SnapshotRestoreRequestProperties' description: SnapshotRestoreRequest resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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. SlotConfigNamesResource: type: object description: Slot Config names azure resource. properties: properties: $ref: '#/components/schemas/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 WorkflowEnvelopeCollection: type: object description: Collection of Kudu workflow information elements. properties: value: type: array description: The WorkflowEnvelope items on this page items: $ref: '#/components/schemas/WorkflowEnvelope' 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 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 NetworkFeaturesProperties: type: object description: NetworkFeatures resource specific properties properties: virtualNetworkName: type: string description: The Virtual Network name. readOnly: true virtualNetworkConnection: $ref: '#/components/schemas/VnetInfo' description: The Virtual Network summary view. readOnly: true hybridConnections: type: array description: The Hybrid Connections summary view. items: $ref: '#/components/schemas/RelayServiceConnectionEntity' readOnly: true hybridConnectionsV2: type: array description: The Hybrid Connection V2 (Service Bus) view. items: $ref: '#/components/schemas/HybridConnection' readOnly: true 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 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: '#/components/schemas/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.' HostType: type: string description: Indicates whether the hostname is a standard or repository hostname. enum: - Standard - Repository x-ms-enum: name: HostType modelAsString: false 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.' SitePatchResource: type: object description: ARM resource for a site. properties: properties: $ref: '#/components/schemas/SitePatchResourceProperties' description: SitePatchResource resource specific properties x-ms-client-flatten: true identity: $ref: '#/components/schemas/ManagedServiceIdentity' description: Managed service identity. allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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 HybridConnection: type: object description: Hybrid Connection contract. This is used to configure a Hybrid Connection. properties: properties: $ref: '#/components/schemas/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 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 Operation: type: object description: An operation on a resource. properties: id: type: string description: Operation ID. name: type: string description: Operation name. status: $ref: '#/components/schemas/OperationStatus' description: The current status of the operation. errors: type: array description: Any errors associate with the operation. items: $ref: '#/components/schemas/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. 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: '#/components/schemas/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. CsmUsageQuotaCollection: type: object description: Paged collection of CsmUsageQuota items properties: value: type: array description: The CsmUsageQuota items on this page items: $ref: '#/components/schemas/CsmUsageQuota' x-ms-identifiers: - name nextLink: type: string format: uri description: The link to the next page of items required: - value RelayServiceConnectionEntity: type: object description: Hybrid Connection for an App Service app. properties: properties: $ref: '#/components/schemas/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 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 ManagedServiceIdentityType: type: string description: Type of managed service identity. enum: - SystemAssigned - UserAssigned - SystemAssigned, UserAssigned - None x-ms-enum: name: ManagedServiceIdentityType modelAsString: false TriggeredJobHistoryProperties: type: object description: TriggeredJobHistory resource specific properties properties: runs: type: array description: List of triggered web job runs. items: $ref: '#/components/schemas/TriggeredJobRun' x-ms-identifiers: - web_job_id 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 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 DeploymentCollection: type: object description: Collection of app deployments. properties: value: type: array description: The Deployment items on this page items: $ref: '#/components/schemas/Deployment' nextLink: type: string format: uri description: The link to the next page of items required: - value 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: '#/components/schemas/ClientRegistration' description: The configuration settings of the app registration for the legacy Microsoft Account provider. login: $ref: '#/components/schemas/LoginScopes' description: The configuration settings of the login flow. validation: $ref: '#/components/schemas/AllowedAudiencesValidation' description: The configuration settings of the legacy Microsoft Account provider token validation flow. BackupRequest: type: object description: Description of a backup which will be performed. properties: properties: $ref: '#/components/schemas/BackupRequestProperties' description: BackupRequest resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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. 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 WebAppInstanceStatusCollection: type: object description: Collection of app instances. properties: value: type: array description: The WebSiteInstanceStatus items on this page items: $ref: '#/components/schemas/WebSiteInstanceStatus' nextLink: type: string format: uri description: The link to the next page of items required: - value AzureStoragePropertyDictionaryResource: type: object description: AzureStorageInfo dictionary resource. properties: properties: type: object description: Azure storage accounts. additionalProperties: $ref: '#/components/schemas/AzureStorageInfoValue' x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' WebJobCollection: type: object description: Collection of Kudu web job information elements. properties: value: type: array description: The WebJob items on this page items: $ref: '#/components/schemas/WebJob' nextLink: type: string format: uri description: The link to the next page of items required: - value 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 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: '#/components/schemas/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 KeyInfo: type: object description: Function key info. properties: name: type: string description: Key name value: type: string description: Key value AzureResourceType: type: string description: Azure resource type. enum: - Website - TrafficManager x-ms-enum: name: AzureResourceType modelAsString: false 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: '#/components/schemas/ContinuousWebJob' nextLink: type: string format: uri description: The link to the next page of items required: - value 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 User: type: object description: User credentials used for publishing activity. properties: properties: $ref: '#/components/schemas/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 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. CustomHostNameDnsRecordType: type: string description: Custom DNS record type. enum: - CName - A x-ms-enum: name: CustomHostNameDnsRecordType 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: '#/components/schemas/AzureResourceType' description: Azure resource type. x-ms-mutability: - read - create customHostNameDnsRecordType: $ref: '#/components/schemas/CustomHostNameDnsRecordType' description: Custom DNS record type. x-ms-mutability: - read - create hostNameType: $ref: '#/components/schemas/HostNameType' description: Hostname type. x-ms-mutability: - read - create sslState: $ref: '#/components/schemas/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 Identifier: type: object description: A domain specific resource identifier. properties: properties: $ref: '#/components/schemas/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 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: '#/components/schemas/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: '#/components/schemas/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. CustomHostnameAnalysisResult: type: object description: Custom domain analysis. properties: properties: $ref: '#/components/schemas/CustomHostnameAnalysisResultProperties' description: CustomHostnameAnalysisResult resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' IdentifierProperties: type: object description: Identifier resource specific properties properties: id: type: string description: String representation of the identity. x-ms-client-name: value SiteExtensionType: type: string description: Site extension type. enum: - Gallery - WebRoot x-ms-enum: name: SiteExtensionType modelAsString: false Experiments: type: object description: Routing rules in production experiments. properties: rampUpRules: type: array description: List of ramp-up rules. items: $ref: '#/components/schemas/RampUpRule' x-ms-identifiers: - name 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. RestoreRequest: type: object description: Description of a restore request. properties: properties: $ref: '#/components/schemas/RestoreRequestProperties' description: RestoreRequest resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' SnapshotProperties: type: object description: Snapshot resource specific properties properties: time: type: string description: The time the snapshot was taken. readOnly: true UsageState: type: string description: State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded x-ms-enum: name: UsageState modelAsString: false NameValuePair: type: object description: Name value pair. properties: name: type: string description: Pair name. value: type: string description: Pair value. 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 SiteConfigResource: type: object description: Web app configuration ARM resource. properties: properties: $ref: '#/components/schemas/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 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). ApiKVReferenceCollection: type: object description: Paged collection of ApiKVReference items properties: value: type: array description: The ApiKVReference items on this page items: $ref: '#/components/schemas/ApiKVReference' 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 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 HostNameBinding: type: object description: A hostname binding object. properties: properties: $ref: '#/components/schemas/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 ContinuousWebJobProperties: type: object description: ContinuousWebJob resource specific properties properties: status: $ref: '#/components/schemas/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: '#/components/schemas/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: {} 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 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: '#/components/schemas/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 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 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: '#/components/schemas/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: {} ContinuousWebJob: type: object description: Continuous Web Job Information. properties: properties: $ref: '#/components/schemas/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 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: '#/components/schemas/LocalizableString' description: Quota name. MSDeployStatus: type: object description: MSDeploy ARM response properties: properties: $ref: '#/components/schemas/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 SiteRuntimeState: type: string enum: - READY - STOPPED - UNKNOWN x-ms-enum: name: SiteRuntimeState modelAsString: false PublicCertificateProperties: type: object description: PublicCertificate resource specific properties properties: blob: type: string format: byte description: Public Certificate byte array publicCertificateLocation: $ref: '#/components/schemas/PublicCertificateLocation' description: Public Certificate Location thumbprint: type: string description: Certificate Thumbprint readOnly: true SiteConfigurationSnapshotInfo: type: object description: A snapshot of a web app configuration. properties: properties: $ref: '#/components/schemas/SiteConfigurationSnapshotInfoProperties' description: SiteConfigurationSnapshotInfo resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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 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 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 PrivateEndpointConnectionCollection: type: object description: Paged collection of RemotePrivateEndpointConnectionARMResource items properties: value: type: array description: The RemotePrivateEndpointConnectionARMResource items on this page items: $ref: '#/components/schemas/RemotePrivateEndpointConnectionARMResource' nextLink: type: string format: uri description: The link to the next page of items required: - value 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 ManagedServiceIdentity: type: object description: Managed service identity. properties: type: $ref: '#/components/schemas/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: '#/components/schemas/UserAssignedIdentity' SiteContainerCollection: type: object description: Collection of site containers properties: value: type: array description: The SiteContainer items on this page items: $ref: '#/components/schemas/SiteContainer' nextLink: type: string format: uri description: The link to the next page of items required: - value 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 PremierAddOn: type: object description: Premier add-on. properties: properties: $ref: '#/components/schemas/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 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 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 WebJobType: type: string description: Job type. enum: - Continuous - Triggered x-ms-enum: name: WebJobType modelAsString: false 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: '#/components/schemas/AzureActiveDirectoryRegistration' description: The configuration settings of the Azure Active Directory app registration. login: $ref: '#/components/schemas/AzureActiveDirectoryLogin' description: The configuration settings of the Azure Active Directory login flow. validation: $ref: '#/components/schemas/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.' 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 ConnectionStringDictionary: type: object description: String dictionary resource. properties: properties: type: object description: Connection strings. additionalProperties: $ref: '#/components/schemas/ConnStringValueTypePair' x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' Snapshot: type: object description: A snapshot of an app. properties: properties: $ref: '#/components/schemas/SnapshotProperties' description: Snapshot resource specific properties x-ms-client-flatten: true allOf: - $ref: '#/components/schemas/ProxyOnlyResource' 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: '#/components/schemas/OpenIdConnectClientCredential' description: The authentication credentials of the custom Open ID Connect provider. openIdConnectConfiguration: $ref: '#/components/schemas/OpenIdConnectConfig' description: The configuration settings of the endpoints used for the custom Open ID Connect provider. ProcessModuleInfo: type: object description: Process Module Information. properties: properties: $ref: '#/components/schemas/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 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 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. 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. FunctionsSiteUpdateStrategy: type: object description: Function app site update strategy configuration for deployments and site config updates. properties: type: $ref: '#/components/schemas/SiteUpdateStrategyType' description: 'Function app site update strategy type. Available options: Recreate, RollingUpdate' WorkflowEnvelopeProperties: type: object description: Additional workflow properties. properties: files: type: object description: Gets or sets the files. additionalProperties: {} flowState: $ref: '#/components/schemas/WorkflowState' description: Gets or sets the state of the workflow. health: $ref: '#/components/schemas/WorkflowHealth' description: Gets or sets workflow health. AzureStorageInfoValue: type: object description: Azure Files or Blob Storage access information value for dictionary storage. properties: type: $ref: '#/components/schemas/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: '#/components/schemas/AzureStorageState' description: State of the storage account. readOnly: true protocol: $ref: '#/components/schemas/AzureStorageProtocol' description: Mounting protocol to use for the storage account. 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: '#/components/schemas/ClientRegistration' description: The configuration settings of the app registration for the Google provider. login: $ref: '#/components/schemas/LoginScopes' description: The configuration settings of the login flow. validation: $ref: '#/components/schemas/AllowedAudiencesValidation' description: The configuration settings of the Azure Active Directory token validation flow. SiteLoadBalancing: type: string description: Site load balancing. enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash - PerSiteRoundRobin - LeastRequestsWithTieBreaker x-ms-enum: name: SiteLoadBalancing modelAsString: false WorkflowEnvelope: type: object description: Workflow properties definition. properties: properties: $ref: '#/components/schemas/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 ContainerInfo: type: object properties: currentTimeStamp: type: string format: date-time previousTimeStamp: type: string format: date-time currentCpuStats: $ref: '#/components/schemas/ContainerCpuStatistics' previousCpuStats: $ref: '#/components/schemas/ContainerCpuStatistics' memoryStats: $ref: '#/components/schemas/ContainerMemoryStatistics' name: type: string id: type: string eth0: $ref: '#/components/schemas/ContainerNetworkInterfaceStatistics' 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: '#/components/schemas/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 VirtualDirectory: type: object description: Directory for virtual application. properties: virtualPath: type: string description: Path to virtual application. physicalPath: type: string description: Physical path. CsmDeploymentStatusCollection: type: object description: Deployment status collection ARM resource. properties: value: type: array description: The CsmDeploymentStatus items on this page items: $ref: '#/components/schemas/CsmDeploymentStatus' nextLink: type: string format: uri description: The link to the next page of items required: - value 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: '#/components/schemas/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: '#/components/schemas/FunctionsScaleAndConcurrencyTriggers' description: Scale and concurrency settings for the function app triggers. 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. 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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/EnvironmentVariable' required: - image - isMain 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: '#/components/schemas/PrivateAccessSubnet' x-ms-identifiers: - key 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 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' PublicCertificate: type: object description: Public certificate object properties: properties: $ref: '#/components/schemas/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 RemotePrivateEndpointConnectionARMResource: type: object description: Remote Private Endpoint Connection ARM resource. properties: properties: $ref: '#/components/schemas/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 WorkflowHealthState: type: string description: Gets or sets the workflow health state. enum: - NotSpecified - Healthy - Unhealthy - Unknown x-ms-enum: name: WorkflowHealthState modelAsString: false MSDeployLogEntryType: type: string description: Log entry type enum: - Message - Warning - Error x-ms-enum: name: MSDeployLogEntryType 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. AutoHealActionType: type: string description: Predefined action to be taken. enum: - Recycle - LogEvent - CustomAction x-ms-enum: name: AutoHealActionType modelAsString: false RedundancyMode: type: string description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant x-ms-enum: name: RedundancyMode modelAsString: false 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. 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: '#/components/schemas/AppleRegistration' description: The configuration settings of the Apple registration. login: $ref: '#/components/schemas/LoginScopes' description: The configuration settings of the login flow. 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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/SiteDnsConfig' description: Property to configure various DNS related settings for a site. siteConfig: $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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}' 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. TriggeredJobHistory: type: object description: Triggered Web Job History. List of Triggered Web Job Run Information elements. properties: properties: $ref: '#/components/schemas/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 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 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 CsmPublishingCredentialsPoliciesEntity: type: object description: Publishing Credentials Policies parameters. properties: properties: $ref: '#/components/schemas/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 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.' ContainerMemoryStatistics: type: object properties: usage: type: integer format: int64 maxUsage: type: integer format: int64 limit: type: integer format: int64 ProcessModuleInfoCollection: type: object description: Collection of Kudu thread information elements. properties: value: type: array description: The ProcessModuleInfo items on this page items: $ref: '#/components/schemas/ProcessModuleInfo' nextLink: type: string format: uri description: The link to the next page of items required: - value securitySchemes: azure_auth: type: oauth2 flows: implicit: scopes: user_impersonation: impersonate your user account authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize description: Azure Active Directory OAuth2 Flow.