swagger: '2.0' info: version: '2023-01-01' title: Microsoft Azure WebApps API Client host: management.azure.com schemes: - https consumes: - application/json produces: - application/json paths: /subscriptions/{subscriptionId}/providers/Microsoft.Web/sites: get: tags: - WebApps summary: 'Microsoft Azure Get All Apps For A Subscription' description: Description for Get all apps for a subscription. operationId: microsoftAzureWebappsList parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/WebAppCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Web apps for subscription: $ref: ./examples/ListWebApps.json x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites: get: tags: - WebApps summary: 'Microsoft Azure Gets All Web, Mobile, And Api Apps In The Specified Resource Group' description: >- Description for Gets all web, mobile, and API apps in the specified resource group. operationId: microsoftAzureWebappsListbyresourcegroup parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: includeSlots in: query description: >- Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all apps. type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/WebAppCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-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: tags: - WebApps summary: 'Microsoft Azure Gets The Details Of A Web, Mobile, Or Api App' description: Description for Gets the details of a web, mobile, or API app. operationId: microsoftAzureWebappsGet parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: ./CommonDefinitions.json#/definitions/Site '404': description: Not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Web App: $ref: ./examples/GetWebApp.json put: tags: - WebApps summary: >- Microsoft Azure Creates A New Web, Mobile, Or Api App In An Existing Resource Group, Or Updates An Existing App description: >- Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. operationId: microsoftAzureWebappsCreateorupdate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: >- Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. required: true type: string - name: siteEnvelope in: body description: A JSON representation of the app properties. See example. required: true schema: $ref: ./CommonDefinitions.json#/definitions/Site - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: ./CommonDefinitions.json#/definitions/Site '202': description: Asynchronous operation in progress. schema: $ref: ./CommonDefinitions.json#/definitions/Site default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Create or Update web app: $ref: ./examples/CreateOrUpdateWebApp.json Clone web app: $ref: ./examples/CloneWebApp.json x-ms-long-running-operation: true delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Web, Mobile, Or Api App, Or One Of The Deployment Slots' description: >- Description for Deletes a web, mobile, or API app, or one of the deployment slots. operationId: microsoftAzureWebappsDelete parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app to delete. required: true type: string - name: deleteMetrics in: query description: If true, web app metrics are also deleted. type: boolean - name: deleteEmptyServerFarm in: query description: >- Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted. type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted web app. '204': description: Successfully deleted web app. '404': description: Web app not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Delete Web app: $ref: ./examples/DeleteWebApp.json patch: tags: - WebApps summary: >- Microsoft Azure Creates A New Web, Mobile, Or Api App In An Existing Resource Group, Or Updates An Existing App description: >- Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. operationId: microsoftAzureWebappsUpdate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: >- Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. required: true type: string - name: siteEnvelope in: body description: A JSON representation of the app properties. See example. required: true schema: $ref: '#/definitions/SitePatchResource' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: ./CommonDefinitions.json#/definitions/Site '202': description: Asynchronous operation in progress. schema: $ref: ./CommonDefinitions.json#/definitions/Site default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update web app: $ref: ./examples/UpdateWebApp.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname : get: tags: - WebApps summary: 'Microsoft Azure Analyze A Custom Hostname' description: Description for Analyze a custom hostname. operationId: microsoftAzureWebappsAnalyzecustomhostname parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: hostName in: query description: Custom hostname. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CustomHostnameAnalysisResult' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Analyze custom hostname for webapp.: $ref: ./examples/AnalyzeCustomHostName.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig: post: tags: - WebApps summary: >- Microsoft Azure Applies The Configuration Settings From The Target Slot Onto The Current Slot description: >- Description for Applies the configuration settings from the target slot onto the current slot. operationId: microsoftAzureWebappsApplyslotconfigtoproduction parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slotSwapEntity in: body description: JSON object that contains the target slot name. See example. required: true schema: $ref: '#/definitions/CsmSlotEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Apply web app slot config: $ref: ./examples/ApplySlotConfig.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup: post: tags: - WebApps summary: 'Microsoft Azure Creates A Backup Of An App' description: Description for Creates a backup of an app. operationId: microsoftAzureWebappsBackup parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: request in: body description: >- Backup configuration. You can use the JSON response from the POST action as input here. required: true schema: $ref: '#/definitions/BackupRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Backup web app: $ref: ./examples/BackupWebApp.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups: get: tags: - WebApps summary: 'Microsoft Azure Gets Existing Backups Of An App' description: Description for Gets existing backups of an app. operationId: microsoftAzureWebappsListbackups parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItemCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: List web app backups: $ref: ./examples/ListWebAppBackups.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}: get: tags: - WebApps summary: 'Microsoft Azure Gets A Backup Of An App By Its Id' description: Description for Gets a backup of an app by its ID. operationId: microsoftAzureWebappsGetbackupstatus parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: backupId in: path description: ID of the backup. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get web app backup: $ref: ./examples/GetWebAppBackup.json delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Backup Of An App By Its Id' description: Description for Deletes a backup of an app by its ID. operationId: microsoftAzureWebappsDeletebackup parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: backupId in: path description: ID of the backup. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted web app backup item. '404': description: Web app backup item does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Delete web app backup: $ref: ./examples/DeleteWebAppBackup.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list : post: tags: - WebApps summary: >- Microsoft Azure Gets Status Of A Web App Backup That May Be In Progress, Including Secrets Associated With The Backup, Such As The Azure Storage Sas Url Also Can Be Used To Update The Sas Url For The Backup If A New Url Is Passed In The Request Body description: >- Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body. operationId: microsoftAzureWebappsListbackupstatussecrets parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: backupId in: path description: ID of backup. required: true type: string - name: request in: body description: Information on backup request. required: true schema: $ref: '#/definitions/BackupRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get web app backup with secrets: $ref: ./examples/GetWebAppBackupWithSecrets.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore : post: tags: - WebApps summary: >- Microsoft Azure Restores A Specific Backup To Another App Or Deployment Slot, If Specified description: >- Description for Restores a specific backup to another app (or deployment slot, if specified). operationId: microsoftAzureWebappsRestore parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: backupId in: path description: ID of the backup. required: true type: string - name: request in: body description: Information on restore request . required: true schema: $ref: '#/definitions/RestoreRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Restore operation started. '202': description: Restore operation started. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Restore web app from backup: $ref: ./examples/RestoreWebAppBackup.json x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies : get: tags: - WebApps summary: >- Microsoft Azure Returns Whether Scm Basic Auth Is Allowed And Whether Ftp Is Allowed For A Given Site description: >- Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site. operationId: microsoftAzureWebappsListbasicpublishingcredentialspolicies parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PublishingCredentialsPoliciesCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Publishing Credentials Policies: $ref: ./examples/ListPublishingCredentialsPolicies.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp : get: tags: - WebApps summary: 'Microsoft Azure Returns Whether Ftp Is Allowed On The Site Or Not' description: Description for Returns whether FTP is allowed on the site or not. operationId: microsoftAzureWebappsGetftpallowed parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get FTP Allowed: $ref: ./examples/GetPublishingCredentialsPolicy.json put: tags: - WebApps summary: 'Microsoft Azure Updates Whether Ftp Is Allowed On The Site Or Not' description: Description for Updates whether FTP is allowed on the site or not. operationId: microsoftAzureWebappsUpdateftpallowed parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: csmPublishingAccessPoliciesEntity in: body required: true schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update FTP Allowed: $ref: ./examples/UpdatePublishingCredentialsPolicy.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm : get: tags: - WebApps summary: 'Microsoft Azure Returns Whether Scm Basic Auth Is Allowed On The Site Or Not' description: >- Description for Returns whether Scm basic auth is allowed on the site or not. operationId: microsoftAzureWebappsGetscmallowed parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get SCM Allowed: $ref: ./examples/GetPublishingCredentialsPolicy.json put: tags: - WebApps summary: >- Microsoft Azure Updates Whether User Publishing Credentials Are Allowed On The Site Or Not description: >- Description for Updates whether user publishing credentials are allowed on the site or not. operationId: microsoftAzureWebappsUpdatescmallowed parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: csmPublishingAccessPoliciesEntity in: body required: true schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update SCM Allowed: $ref: ./examples/UpdatePublishingCredentialsPolicy.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config: get: tags: - WebApps summary: Microsoft Azure List The Configurations Of An App description: Description for List the configurations of an app operationId: microsoftAzureWebappsListconfigurations parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResourceCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: List web app configurations: $ref: ./examples/ListWebAppConfigurations.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings: put: tags: - WebApps summary: 'Microsoft Azure Replaces The Application Settings Of An App' description: Description for Replaces the application settings of an app. operationId: microsoftAzureWebappsUpdateapplicationsettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: appSettings in: body description: Application settings of the app. required: true schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update App Settings: $ref: ./examples/UpdateAppSettings.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Application Settings Of An App' description: Description for Gets the application settings of an app. operationId: microsoftAzureWebappsListapplicationsettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List App Settings: $ref: ./examples/ListAppSettings.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings : put: tags: - WebApps summary: >- Microsoft Azure Updates The Authentication Authorization Settings Associated With Web App description: >- Description for Updates the Authentication / Authorization settings associated with web app. operationId: microsoftAzureWebappsUpdateauthsettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: siteAuthSettings in: body description: Auth settings associated with web app. required: true schema: $ref: '#/definitions/SiteAuthSettings' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update Auth Settings: $ref: ./examples/UpdateAuthSettings.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Authentication Authorization Settings Of An App' description: >- Description for Gets the Authentication/Authorization settings of an app. operationId: microsoftAzureWebappsGetauthsettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Auth Settings: $ref: ./examples/ListAuthSettings.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2 : get: tags: - WebApps summary: >- Microsoft Azure Gets Site S Authentication Authorization Settings For Apps Via The Format description: >- Description for Gets site's Authentication / Authorization settings for apps via the V2 format operationId: microsoftAzureWebappsGetauthsettingsv2withoutsecrets parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettingsV2' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Auth Settings without Secrets: $ref: ./examples/GetAuthSettingsV2WithoutSecrets.json put: tags: - WebApps summary: >- Microsoft Azure Updates Site S Authentication Authorization Settings For Apps Via The Format description: >- Description for Updates site's Authentication / Authorization settings for apps via the V2 format operationId: microsoftAzureWebappsUpdateauthsettingsv2 parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: siteAuthSettingsV2 in: body description: Auth settings associated with web app. required: true schema: $ref: '#/definitions/SiteAuthSettingsV2' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettingsV2' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update Auth Settings V2: $ref: ./examples/UpdateAuthSettingsV2.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list : get: tags: - WebApps summary: >- Microsoft Azure Gets Site S Authentication Authorization Settings For Apps Via The Format description: >- Description for Gets site's Authentication / Authorization settings for apps via the V2 format operationId: microsoftAzureWebappsGetauthsettingsv2 parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettingsV2' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Auth Settings V2: $ref: ./examples/ListAuthSettingsV2.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts : put: tags: - WebApps summary: 'Microsoft Azure Updates The Azure Storage Account Configurations Of An App' description: >- Description for Updates the Azure storage account configurations of an app. operationId: microsoftAzureWebappsUpdateazurestorageaccounts parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: azureStorageAccounts in: body description: Azure storage accounts of the app. required: true schema: $ref: '#/definitions/AzureStoragePropertyDictionaryResource' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AzureStoragePropertyDictionaryResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update Azure Storage Accounts: $ref: ./examples/UpdateAzureStorageAccounts.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Azure Storage Account Configurations Of An App' description: Description for Gets the Azure storage account configurations of an app. operationId: microsoftAzureWebappsListazurestorageaccounts parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AzureStoragePropertyDictionaryResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup: put: tags: - WebApps summary: 'Microsoft Azure Updates The Backup Configuration Of An App' description: Description for Updates the backup configuration of an app. operationId: microsoftAzureWebappsUpdatebackupconfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: request in: body description: Edited backup configuration. required: true schema: $ref: '#/definitions/BackupRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes The Backup Configuration Of An App' description: Description for Deletes the backup configuration of an app. operationId: microsoftAzureWebappsDeletebackupconfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted backup configuration. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list: post: tags: - WebApps summary: 'Microsoft Azure Gets The Backup Configuration Of An App' description: Description for Gets the backup configuration of an app. operationId: microsoftAzureWebappsGetbackupconfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings : get: tags: - WebApps summary: Microsoft Azure 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 operationId: microsoftAzureWebappsGetappsettingskeyvaultreferences parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ApiKVReferenceCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Azure Key Vault references for app settings: $ref: ./examples/GetKeyVaultReferencesForAppSettings.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey} : get: tags: - WebApps summary: Microsoft Azure Gets The Config Reference And Status Of An App description: Description for Gets the config reference and status of an app operationId: microsoftAzureWebappsGetappsettingkeyvaultreference parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: appSettingKey in: path description: App Setting key name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ApiKVReference' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Azure Key Vault app setting reference: $ref: ./examples/GetKeyVaultReferencesForAppSetting.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings : get: tags: - WebApps summary: Microsoft Azure 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 operationId: microsoftAzureWebappsGetsiteconnectionstringkeyvaultreferences parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ApiKVReferenceCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings/{connectionStringKey} : get: tags: - WebApps summary: Microsoft Azure Gets The Config Reference And Status Of An App description: Description for Gets the config reference and status of an app operationId: microsoftAzureWebappsGetsiteconnectionstringkeyvaultreference parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: connectionStringKey in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ApiKVReference' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings : put: tags: - WebApps summary: 'Microsoft Azure Replaces The Connection Strings Of An App' description: Description for Replaces the connection strings of an app. operationId: microsoftAzureWebappsUpdateconnectionstrings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: connectionStrings in: body description: Connection strings of the app or deployment slot. See example. required: true schema: $ref: '#/definitions/ConnectionStringDictionary' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Connection Strings Of An App' description: Description for Gets the connection strings of an app. operationId: microsoftAzureWebappsListconnectionstrings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs: get: tags: - WebApps summary: 'Microsoft Azure Gets The Logging Configuration Of An App' description: Description for Gets the logging configuration of an app. operationId: microsoftAzureWebappsGetdiagnosticlogsconfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Updates The Logging Configuration Of An App' description: Description for Updates the logging configuration of an app. operationId: microsoftAzureWebappsUpdatediagnosticlogsconfig parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteLogsConfig in: body description: >- A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties" property. required: true schema: $ref: '#/definitions/SiteLogsConfig' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata: put: tags: - WebApps summary: 'Microsoft Azure Replaces The Metadata Of An App' description: Description for Replaces the metadata of an app. operationId: microsoftAzureWebappsUpdatemetadata parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: metadata in: body description: Edited metadata of the app or deployment slot. See example. required: true schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Metadata Of An App' description: Description for Gets the metadata of an app. operationId: microsoftAzureWebappsListmetadata parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Git Ftp Publishing Credentials Of An App' description: Description for Gets the Git/FTP publishing credentials of an app. operationId: microsoftAzureWebappsListpublishingcredentials parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/User default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings : put: tags: - WebApps summary: 'Microsoft Azure Updates The Push Settings Associated With Web App' description: Description for Updates the Push settings associated with web app. operationId: microsoftAzureWebappsUpdatesitepushsettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: pushSettings in: body description: Push settings associated with web app. required: true schema: $ref: ./CommonDefinitions.json#/definitions/PushSettings - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/PushSettings default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Push Settings Associated With Web App' description: Description for Gets the Push settings associated with web app. operationId: microsoftAzureWebappsListsitepushsettings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/PushSettings default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames : get: tags: - WebApps summary: >- Microsoft Azure Gets The Names Of App Settings And Connection Strings That Stick To The Slot Not Swapped description: >- Description for Gets the names of app settings and connection strings that stick to the slot (not swapped). operationId: microsoftAzureWebappsListslotconfigurationnames parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotConfigNamesResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: >- Microsoft Azure Updates The Names Of Application Settings And Connection String That Remain With The Slot During Swap Operation description: >- Description for Updates the names of application settings and connection string that remain with the slot during swap operation. operationId: microsoftAzureWebappsUpdateslotconfigurationnames parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slotConfigNames in: body description: Names of application settings and connection strings. See example. required: true schema: $ref: '#/definitions/SlotConfigNamesResource' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotConfigNamesResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web: get: tags: - WebApps summary: >- Microsoft Azure Gets The Configuration Of An App, Such As Platform Version And Bitness, Default Documents, Virtual Applications, Always On, Etc description: >- Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc. operationId: microsoftAzureWebappsGetconfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Site Config: $ref: ./examples/GetSiteConfig.json put: tags: - WebApps summary: 'Microsoft Azure Updates The Configuration Of An App' description: Description for Updates the configuration of an app. operationId: microsoftAzureWebappsCreateorupdateconfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteConfig in: body description: JSON representation of a SiteConfig object. See example. required: true schema: $ref: '#/definitions/SiteConfigResource' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update Site Config: $ref: ./examples/UpdateSiteConfig.json patch: tags: - WebApps summary: 'Microsoft Azure Updates The Configuration Of An App' description: Description for Updates the configuration of an app. operationId: microsoftAzureWebappsUpdateconfiguration parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteConfig in: body description: JSON representation of a SiteConfig object. See example. required: true schema: $ref: '#/definitions/SiteConfigResource' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots : get: tags: - WebApps summary: >- Microsoft Azure Gets A List Of Web App Configuration Snapshots Identifiers Each Element Of The List Contains A Timestamp And The Id Of The Snapshot description: >- Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot. operationId: microsoftAzureWebappsListconfigurationsnapshotinfo parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigurationSnapshotInfoCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Snapshot Of The Configuration Of An App At A Previous Point In Time description: >- Description for Gets a snapshot of the configuration of an app at a previous point in time. operationId: microsoftAzureWebappsGetconfigurationsnapshot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: snapshotId in: path description: The ID of the snapshot to read. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover : post: tags: - WebApps summary: 'Microsoft Azure Reverts The Configuration Of An App To A Previous Snapshot' description: >- Description for Reverts the configuration of an app to a previous snapshot. operationId: microsoftAzureWebappsRecoversiteconfigurationsnapshot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: snapshotId in: path description: The ID of the snapshot to read. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs: post: tags: - WebApps summary: Microsoft Azure Gets The Last Lines Of Docker Logs For The Given Site description: Description for Gets the last lines of docker logs for the given site operationId: microsoftAzureWebappsGetwebsitecontainerlogs produces: - application/octet-stream parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download : post: tags: - WebApps summary: Microsoft Azure Gets The Zip Archived Docker Log Files For The Given Site description: >- Description for Gets the ZIP archived docker log files for the given site operationId: microsoftAzureWebappsGetcontainerlogszip produces: - application/zip parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs: get: tags: - WebApps summary: 'Microsoft Azure List Continuous Web Jobs For An App, Or A Deployment Slot' description: >- Description for List continuous web jobs for an app, or a deployment slot. operationId: microsoftAzureWebappsListcontinuouswebjobs parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ContinuousWebJobCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName} : get: tags: - WebApps summary: 'Microsoft Azure Gets A Continuous Web Job By Its Id For An App, Or A Deployment Slot' description: >- Description for Gets a continuous web job by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsGetcontinuouswebjob parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. schema: $ref: '#/definitions/ContinuousWebJob' '404': description: Continuous web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Continuous Web Job By Its Id For An App, Or A Deployment Slot' description: >- Description for Delete a continuous web job by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsDeletecontinuouswebjob parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted continuous web job. '204': description: Continuous web job does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start : post: tags: - WebApps summary: 'Microsoft Azure Start A Continuous Web Job For An App, Or A Deployment Slot' description: >- Description for Start a continuous web job for an app, or a deployment slot. operationId: microsoftAzureWebappsStartcontinuouswebjob parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. '404': description: Continuous web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop : post: tags: - WebApps summary: 'Microsoft Azure Stop A Continuous Web Job For An App, Or A Deployment Slot' description: >- Description for Stop a continuous web job for an app, or a deployment slot. operationId: microsoftAzureWebappsStopcontinuouswebjob parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. '404': description: Continuous web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus: get: tags: - WebApps summary: 'Microsoft Azure List Deployment Statuses For An App Or Deployment Slot, If Specified' operationId: microsoftAzureWebappsListproductionsitedeploymentstatuses parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmDeploymentStatusCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Deployment Status: $ref: ./examples/ListSiteDeploymentStatus.json x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId} : get: tags: - WebApps summary: 'Microsoft Azure Gets The Deployment Status For An App Or Deployment Slot, If Specified' operationId: microsoftAzureWebappsGetproductionsitedeploymentstatus parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: deploymentStatusId in: path description: GUID of the deployment operation. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmDeploymentStatus' '202': description: Operation is in progress. schema: $ref: '#/definitions/CsmDeploymentStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Deployment Status: $ref: ./examples/GetSiteDeploymentStatus.json x-ms-long-running-operation: true description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments: get: tags: - WebApps summary: 'Microsoft Azure List Deployments For An App, Or A Deployment Slot' description: Description for List deployments for an app, or a deployment slot. operationId: microsoftAzureWebappsListdeployments parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DeploymentCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}: get: tags: - WebApps summary: 'Microsoft Azure Get A Deployment By Its Id For An App, Or A Deployment Slot' description: >- Description for Get a deployment by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsGetdeployment parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: id in: path description: Deployment ID. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Create A Deployment For An App, Or A Deployment Slot' description: Description for Create a deployment for an app, or a deployment slot. operationId: microsoftAzureWebappsCreatedeployment parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: id in: path description: ID of an existing deployment. required: true type: string - name: deployment in: body description: Deployment details. required: true schema: $ref: '#/definitions/Deployment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Deployment By Its Id For An App, Or A Deployment Slot' description: >- Description for Delete a deployment by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsDeletedeployment parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: id in: path description: Deployment ID. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted deployment. '204': description: Deployment does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log : get: tags: - WebApps summary: >- Microsoft Azure List Deployment Log For Specific Deployment For An App, Or A Deployment Slot description: >- Description for List deployment log for specific deployment for an app, or a deployment slot. operationId: microsoftAzureWebappsListdeploymentlog parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: id in: path description: >- The ID of a specific deployment. This is the value of the name property in the JSON response from "GET /api/sites/{siteName}/deployments". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup: post: tags: - WebApps summary: >- Microsoft Azure Discovers An Existing App Backup That Can Be Restored From A Blob In Azure Storage Use This To Get Information About The Databases Stored In A Backup description: >- Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup. operationId: microsoftAzureWebappsDiscoverbackup parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: request in: body description: >- A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup. required: true schema: $ref: '#/definitions/RestoreRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RestoreRequest' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers : get: tags: - WebApps summary: 'Microsoft Azure Lists Ownership Identifiers For Domain Associated With Web App' description: >- Description for Lists ownership identifiers for domain associated with web app. operationId: microsoftAzureWebappsListdomainownershipidentifiers parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/IdentifierCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} : get: tags: - WebApps summary: 'Microsoft Azure Get Domain Ownership Identifier For Web App' description: Description for Get domain ownership identifier for web app. operationId: microsoftAzureWebappsGetdomainownershipidentifier parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/Identifier default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: >- Microsoft Azure Creates A Domain Ownership Identifier For Web App, Or Updates An Existing Ownership Identifier description: >- Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier. operationId: microsoftAzureWebappsCreateorupdatedomainownershipidentifier parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true type: string - name: domainOwnershipIdentifier in: body description: A JSON representation of the domain ownership properties. required: true schema: $ref: ./CommonDefinitions.json#/definitions/Identifier - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/Identifier default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Domain Ownership Identifier For A Web App' description: Description for Deletes a domain ownership identifier for a web app. operationId: microsoftAzureWebappsDeletedomainownershipidentifier parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted domain ownership identifier. '204': description: Domain ownership identifier does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: >- Microsoft Azure Creates A Domain Ownership Identifier For Web App, Or Updates An Existing Ownership Identifier description: >- Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier. operationId: microsoftAzureWebappsUpdatedomainownershipidentifier parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true type: string - name: domainOwnershipIdentifier in: body description: A JSON representation of the domain ownership properties. required: true schema: $ref: ./CommonDefinitions.json#/definitions/Identifier - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/Identifier default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy : get: tags: - WebApps summary: 'Microsoft Azure Get The Status Of The Last Msdeploy Operation' description: Description for Get the status of the last MSDeploy operation. operationId: microsoftAzureWebappsGetmsdeploystatus parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MSDeployStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Invoke The Msdeploy Web App Extension' description: Description for Invoke the MSDeploy web app extension. operationId: microsoftAzureWebappsCreatemsdeployoperation parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: MSDeploy in: body description: Details of MSDeploy operation required: true schema: $ref: '#/definitions/MSDeploy' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '201': description: Deployment is scheduled. schema: $ref: '#/definitions/MSDeployStatus' '409': description: Another deployment is in progress. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log : get: tags: - WebApps summary: 'Microsoft Azure Get The Msdeploy Log For The Last Msdeploy Operation' description: Description for Get the MSDeploy Log for the last MSDeploy operation. operationId: microsoftAzureWebappsGetmsdeploylog parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: MSDeploy log returned. schema: $ref: '#/definitions/MSDeployLog' '404': description: MSDeploy log not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy : get: tags: - WebApps summary: >- Microsoft Azure Invoke Onedeploy Status Api Api Deployments And Gets The Deployment Status For The Site description: >- Description for Invoke onedeploy status API /api/deployments and gets the deployment status for the site operationId: microsoftAzureWebappsGetonedeploystatus parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: object default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Invoke The Onedeploy Publish Web App Extension' description: Description for Invoke the OneDeploy publish web app extension. operationId: microsoftAzureWebappsCreateonedeployoperation parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: object default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions: get: tags: - WebApps summary: 'Microsoft Azure List The Functions For A Web Site, Or A Deployment Slot' description: Description for List the functions for a web site, or a deployment slot. operationId: microsoftAzureWebappsListfunctions parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Function information returned. schema: $ref: '#/definitions/FunctionEnvelopeCollection' '404': description: Function with an ID of {functionName} is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token : get: tags: - WebApps summary: 'Microsoft Azure Fetch A Short Lived Token That Can Be Exchanged For A Master Key' description: >- Description for Fetch a short lived token that can be exchanged for a master key. operationId: microsoftAzureWebappsGetfunctionsadmintoken parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: string default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName} : get: tags: - WebApps summary: 'Microsoft Azure Get Function Information By Its Id For Web Site, Or A Deployment Slot' description: >- Description for Get function information by its ID for web site, or a deployment slot. operationId: microsoftAzureWebappsGetfunction parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Function information returned. schema: $ref: '#/definitions/FunctionEnvelope' '404': description: Function with a name of {functionName} does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Create Function For Web Site, Or A Deployment Slot' description: Description for Create function for web site, or a deployment slot. operationId: microsoftAzureWebappsCreatefunction parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - name: function_envelope in: body description: Function details. required: true schema: $ref: '#/definitions/FunctionEnvelope' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '201': description: Function created. schema: $ref: '#/definitions/FunctionEnvelope' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true delete: tags: - WebApps summary: 'Microsoft Azure Delete A Function For Web Site, Or A Deployment Slot' description: Description for Delete a function for web site, or a deployment slot. operationId: microsoftAzureWebappsDeletefunction parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Function deleted. '404': description: Function does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/keys/{keyName} : put: tags: - WebApps summary: 'Microsoft Azure Add Or Update A Function Secret' description: Description for Add or update a function secret. operationId: microsoftAzureWebappsCreateorupdatefunctionsecret parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: The name of the function. required: true type: string - name: keyName in: path description: The name of the key. required: true type: string - name: key in: body description: The key to create or update required: true schema: $ref: '#/definitions/KeyInfo' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Key was updated. schema: $ref: '#/definitions/KeyInfo' '201': description: Key was created. schema: $ref: '#/definitions/KeyInfo' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Function Secret' description: Description for Delete a function secret. operationId: microsoftAzureWebappsDeletefunctionsecret parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: The name of the function. required: true type: string - name: keyName in: path description: The name of the key. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Key was deleted. '404': description: Key was not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listkeys : post: tags: - WebApps summary: 'Microsoft Azure Get Function Keys For A Function In A Web Site, Or A Deployment Slot' description: >- Description for Get function keys for a function in a web site, or a deployment slot. operationId: microsoftAzureWebappsListfunctionkeys parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Function keys returned. schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets : post: tags: - WebApps summary: 'Microsoft Azure Get Function Secrets For A Function In A Web Site, Or A Deployment Slot' description: >- Description for Get function secrets for a function in a web site, or a deployment slot. operationId: microsoftAzureWebappsListfunctionsecrets parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Function secrets returned. schema: $ref: '#/definitions/FunctionSecrets' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys : post: tags: - WebApps summary: 'Microsoft Azure Get Host Secrets For A Function App' description: Description for Get host secrets for a function app. operationId: microsoftAzureWebappsListhostkeys parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Host secrets returned. schema: $ref: '#/definitions/HostKeys' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus : post: tags: - WebApps summary: 'Microsoft Azure This Is To Allow Calling Via Powershell And Arm Template' description: >- Description for This is to allow calling via powershell and ARM template. operationId: microsoftAzureWebappsListsyncstatus parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync: post: tags: - WebApps summary: Microsoft Azure Syncs Function Trigger Metadata To The Management Database description: >- Description for Syncs function trigger metadata to the management database operationId: microsoftAzureWebappsSyncfunctions parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName} : put: tags: - WebApps summary: 'Microsoft Azure Add Or Update A Host Level Secret' description: Description for Add or update a host level secret. operationId: microsoftAzureWebappsCreateorupdatehostsecret parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: keyType in: path description: The type of host key. required: true type: string - name: keyName in: path description: The name of the key. required: true type: string - name: key in: body description: The key to create or update required: true schema: $ref: '#/definitions/KeyInfo' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Key was updated. schema: $ref: '#/definitions/KeyInfo' '201': description: Key was created. schema: $ref: '#/definitions/KeyInfo' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Host Level Secret' description: Description for Delete a host level secret. operationId: microsoftAzureWebappsDeletehostsecret parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: keyType in: path description: The type of host key. required: true type: string - name: keyName in: path description: The name of the key. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Key was deleted. '404': description: Key was not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings: get: tags: - WebApps summary: 'Microsoft Azure Get Hostname Bindings For An App Or A Deployment Slot' description: Description for Get hostname bindings for an app or a deployment slot. operationId: microsoftAzureWebappsListhostnamebindings parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBindingCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName} : get: tags: - WebApps summary: >- Microsoft Azure Get The Named Hostname Binding For An App Or Deployment Slot, If Specified description: >- Description for Get the named hostname binding for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsGethostnamebinding parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: hostName in: path description: Hostname in the hostname binding. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBinding' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Creates A Hostname Binding For An App' description: Description for Creates a hostname binding for an app. operationId: microsoftAzureWebappsCreateorupdatehostnamebinding parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: hostName in: path description: Hostname in the hostname binding. required: true type: string - name: hostNameBinding in: body description: >- Binding details. This is the JSON representation of a HostNameBinding object. required: true schema: $ref: '#/definitions/HostNameBinding' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBinding' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Hostname Binding For An App' description: Description for Deletes a hostname binding for an app. operationId: microsoftAzureWebappsDeletehostnamebinding parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: hostName in: path description: Hostname in the hostname binding. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted hostname binding. '204': description: Hostname binding does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} : get: tags: - WebApps summary: 'Microsoft Azure Retrieves A Specific Service Bus Hybrid Connection Used By This Web App' description: >- Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App. operationId: microsoftAzureWebappsGethybridconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Creates A New Hybrid Connection Using A Service Bus Relay' description: >- Description for Creates a new Hybrid Connection using a Service Bus relay. operationId: microsoftAzureWebappsCreateorupdatehybridconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true type: string - name: connectionEnvelope in: body description: The details of the hybrid connection. required: true schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Removes A Hybrid Connection From This Site' description: Description for Removes a Hybrid Connection from this site. operationId: microsoftAzureWebappsDeletehybridconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted hybrid connection. '404': description: Hybrid connection does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: 'Microsoft Azure Creates A New Hybrid Connection Using A Service Bus Relay' description: >- Description for Creates a new Hybrid Connection using a Service Bus relay. operationId: microsoftAzureWebappsUpdatehybridconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true type: string - name: connectionEnvelope in: body description: The details of the hybrid connection. required: true schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays : get: tags: - WebApps summary: 'Microsoft Azure Retrieves All Service Bus Hybrid Connections Used By This Web App' description: >- Description for Retrieves all Service Bus Hybrid Connections used by this Web App. operationId: microsoftAzureWebappsListhybridconnections parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection: get: tags: - WebApps summary: >- Microsoft Azure Gets Hybrid Connections Configured For An App Or Deployment Slot, If Specified description: >- Description for Gets hybrid connections configured for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsListrelayserviceconnections parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName} : get: tags: - WebApps summary: 'Microsoft Azure Gets A Hybrid Connection Configuration By Its Name' description: Description for Gets a hybrid connection configuration by its name. operationId: microsoftAzureWebappsGetrelayserviceconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: entityName in: path description: Name of the hybrid connection. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: >- Microsoft Azure Creates A New Hybrid Connection Configuration Put , Or Updates An Existing One Patch description: >- Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH). operationId: microsoftAzureWebappsCreateorupdaterelayserviceconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: entityName in: path description: Name of the hybrid connection configuration. required: true type: string - name: connectionEnvelope in: body description: Details of the hybrid connection configuration. required: true schema: $ref: '#/definitions/RelayServiceConnectionEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Relay Service Connection By Its Name' description: Description for Deletes a relay service connection by its name. operationId: microsoftAzureWebappsDeleterelayserviceconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: entityName in: path description: Name of the hybrid connection configuration. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted relay service connection. '404': description: Relay service connection does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: >- Microsoft Azure Creates A New Hybrid Connection Configuration Put , Or Updates An Existing One Patch description: >- Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH). operationId: microsoftAzureWebappsUpdaterelayserviceconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: entityName in: path description: Name of the hybrid connection configuration. required: true type: string - name: connectionEnvelope in: body description: Details of the hybrid connection configuration. required: true schema: $ref: '#/definitions/RelayServiceConnectionEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances: get: tags: - WebApps summary: 'Microsoft Azure Gets All Scale Out Instances Of An App' description: Description for Gets all scale-out instances of an app. operationId: microsoftAzureWebappsListinstanceidentifiers parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WebAppInstanceStatusCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId} : get: tags: - WebApps summary: 'Microsoft Azure Gets All Scale Out Instances Of An App' description: Description for Gets all scale-out instances of an app. operationId: microsoftAzureWebappsGetinstanceinfo parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: instanceId in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WebSiteInstanceStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get site instance info: $ref: ./examples/GetSiteInstanceInfo.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy : get: tags: - WebApps summary: 'Microsoft Azure Get The Status Of The Last Msdeploy Operation' description: Description for Get the status of the last MSDeploy operation. operationId: microsoftAzureWebappsGetinstancemsdeploystatus parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: instanceId in: path description: ID of web app instance. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MSDeployStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Invoke The Msdeploy Web App Extension' description: Description for Invoke the MSDeploy web app extension. operationId: microsoftAzureWebappsCreateinstancemsdeployoperation parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: instanceId in: path description: ID of web app instance. required: true type: string - name: MSDeploy in: body description: Details of MSDeploy operation required: true schema: $ref: '#/definitions/MSDeploy' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '201': description: Deployment is scheduled. schema: $ref: '#/definitions/MSDeployStatus' '409': description: Another deployment is in progress. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log : get: tags: - WebApps summary: 'Microsoft Azure Get The Msdeploy Log For The Last Msdeploy Operation' description: Description for Get the MSDeploy Log for the last MSDeploy operation. operationId: microsoftAzureWebappsGetinstancemsdeploylog parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: instanceId in: path description: ID of web app instance. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: MSDeploy log returned. schema: $ref: '#/definitions/MSDeployLog' '404': description: MSDeploy log not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes : get: tags: - WebApps summary: >- Microsoft Azure Get List Of Processes For A Web Site, Or A Deployment Slot, Or For A Specific Scaled Out Instance In A Web Site description: >- Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListinstanceprocesses parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Process terminated. schema: $ref: '#/definitions/ProcessInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId} : get: tags: - WebApps summary: >- Microsoft Azure Get Process Information By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get process information by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetinstanceprocess parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Process information returned. schema: $ref: '#/definitions/ProcessInfo' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: >- Microsoft Azure Terminate A Process By Its Id For A Web Site, Or A Deployment Slot, Or Specific Scaled Out Instance In A Web Site description: >- Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site. operationId: microsoftAzureWebappsDeleteinstanceprocess parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Process terminated. '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump : get: tags: - WebApps summary: >- Microsoft Azure Get A Memory Dump Of A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetinstanceprocessdump parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules : get: tags: - WebApps summary: >- Microsoft Azure List Module Information For A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for List module information for a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListinstanceprocessmodules parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Module information returned. schema: $ref: '#/definitions/ProcessModuleInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress} : get: tags: - WebApps summary: >- Microsoft Azure Get Process Information By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get process information by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetinstanceprocessmodule parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: baseAddress in: path description: Module base address. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Module information returned. schema: $ref: '#/definitions/ProcessModuleInfo' '404': description: >- Process with the specified ID is not running, or a module with the specified baseAddress was not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads : get: tags: - WebApps summary: >- Microsoft Azure List The Threads In A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for List the threads in a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListinstanceprocessthreads parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Thread information returned. schema: $ref: '#/definitions/ProcessThreadInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable: post: tags: - WebApps summary: >- Microsoft Azure Shows Whether An App Can Be Cloned To Another Resource Group Or Subscription description: >- Description for Shows whether an app can be cloned to another resource group or subscription. operationId: microsoftAzureWebappsIscloneable parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/SiteCloneability' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listbackups: post: tags: - WebApps summary: 'Microsoft Azure Gets Existing Backups Of An App' description: Description for Gets existing backups of an app. operationId: microsoftAzureWebappsListsitebackups parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItemCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List backups: $ref: ./examples/ListSlotBackups.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus : post: tags: - WebApps summary: 'Microsoft Azure This Is To Allow Calling Via Powershell And Arm Template' description: >- Description for This is to allow calling via powershell and ARM template. operationId: microsoftAzureWebappsListsyncfunctiontriggers parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/FunctionSecrets' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate: put: tags: - WebApps summary: 'Microsoft Azure Restores A Web App' description: Description for Restores a web app. operationId: microsoftAzureWebappsMigratestorage parameters: - name: subscriptionName in: query description: Azure subscription. required: true type: string - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: migrationOptions in: body description: Migration migrationOptions. required: true schema: $ref: '#/definitions/StorageMigrationOptions' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StorageMigrationResponse' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql: post: tags: - WebApps summary: 'Microsoft Azure Migrates A Local In App Mysql Database To A Remote Mysql Database' description: >- Description for Migrates a local (in-app) MySql database to a remote MySql database. operationId: microsoftAzureWebappsMigratemysql parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: migrationRequestEnvelope in: body description: MySql migration options. required: true schema: $ref: '#/definitions/MigrateMySqlRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/Operation default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status : get: tags: - WebApps summary: >- Microsoft Azure Returns The Status Of Mysql In App Migration, If One Is Active, And Whether Or Not Mysql In App Is Enabled description: >- Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled operationId: microsoftAzureWebappsGetmigratemysqlstatus parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MigrateMySqlStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork : get: tags: - WebApps summary: 'Microsoft Azure Gets A Swift Virtual Network Connection' description: Description for Gets a Swift Virtual Network connection. operationId: microsoftAzureWebappsGetswiftvirtualnetworkconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/SwiftVirtualNetwork' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: "Microsoft Azure Integrates This Web App With A Virtual Network This Requires That 1 \"swiftsupported\" Is True When Doing A Get Against This Resource, And 2 That The Target Subnet Has Already Been Delegated, And Is Not\r\nin Use By Another App Service Plan Other Than The One This App Is In" description: >- Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not
in use by another App Service Plan other than the one this App is in. operationId: >- microsoftAzureWebappsCreateorupdateswiftvirtualnetworkconnectionwithcheck parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: connectionEnvelope in: body description: Properties of the Virtual Network connection. See example. required: true schema: $ref: '#/definitions/SwiftVirtualNetwork' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SwiftVirtualNetwork' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: >- Microsoft Azure Deletes A Swift Virtual Network Connection From An App Or Deployment Slot description: >- Description for Deletes a Swift Virtual Network connection from an app (or deployment slot). operationId: microsoftAzureWebappsDeleteswiftvirtualnetwork parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted virtual network. '404': description: Virtual network does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: "Microsoft Azure Integrates This Web App With A Virtual Network This Requires That 1 \"swiftsupported\" Is True When Doing A Get Against This Resource, And 2 That The Target Subnet Has Already Been Delegated, And Is Not\r\nin Use By Another App Service Plan Other Than The One This App Is In" description: >- Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not
in use by another App Service Plan other than the one this App is in. operationId: microsoftAzureWebappsUpdateswiftvirtualnetworkconnectionwithcheck parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: connectionEnvelope in: body description: Properties of the Virtual Network connection. See example. required: true schema: $ref: '#/definitions/SwiftVirtualNetwork' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SwiftVirtualNetwork' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view} : get: tags: - WebApps summary: >- Microsoft Azure Gets All Network Features Used By The App Or Deployment Slot, If Specified description: >- Description for Gets all network features used by the app (or deployment slot, if specified). operationId: microsoftAzureWebappsListnetworkfeatures parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: view in: path description: The type of view. Only "summary" is supported at this time. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/NetworkFeatures' '404': description: The requested view does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Named Operation For A Network Trace Capturing Or Deployment Slot, If Specified description: >- Description for Gets a named operation for a network trace capturing (or deployment slot, if specified). operationId: microsoftAzureWebappsGetnetworktraceoperation parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: operationId in: path description: GUID of the operation. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' '202': description: Operation is in progress. schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get the current status of a network trace operation for a site: $ref: ./examples/GetWebSiteNetworkTraceOperation.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start: post: tags: - WebApps summary: 'Microsoft Azure Start Capturing Network Packets For The Site To Be Deprecated' description: >- Description for Start capturing network packets for the site (To be deprecated). operationId: microsoftAzureWebappsStartwebsitenetworktrace parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. type: integer format: int32 - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: string default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation : post: tags: - WebApps summary: 'Microsoft Azure Start Capturing Network Packets For The Site' description: Description for Start capturing network packets for the site. operationId: microsoftAzureWebappsStartwebsitenetworktraceoperation parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. type: integer format: int32 - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' '202': description: Operation is in progress. schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Start a new network trace operation for a site: $ref: ./examples/StartWebSiteNetworkTraceOperation.json x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop: post: tags: - WebApps summary: 'Microsoft Azure Stop Ongoing Capturing Network Packets For The Site' description: Description for Stop ongoing capturing network packets for the site. operationId: microsoftAzureWebappsStopwebsitenetworktrace parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Stopped. '204': description: Stopped. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Stop a currently running network trace operation for a site: $ref: ./examples/StopWebSiteNetworkTrace.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Named Operation For A Network Trace Capturing Or Deployment Slot, If Specified description: >- Description for Gets a named operation for a network trace capturing (or deployment slot, if specified). operationId: microsoftAzureWebappsGetnetworktraces parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: operationId in: path description: GUID of the operation. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get NetworkTraces for a site: $ref: ./examples/GetWebSiteNetworkTraces.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Named Operation For A Network Trace Capturing Or Deployment Slot, If Specified description: >- Description for Gets a named operation for a network trace capturing (or deployment slot, if specified). operationId: microsoftAzureWebappsGetnetworktraceoperationv2 parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: operationId in: path description: GUID of the operation. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' '202': description: Operation is in progress. schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get the current status of a network trace operation for a site: $ref: ./examples/GetWebSiteNetworkTraceOperation.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Named Operation For A Network Trace Capturing Or Deployment Slot, If Specified description: >- Description for Gets a named operation for a network trace capturing (or deployment slot, if specified). operationId: microsoftAzureWebappsGetnetworktracesv2 parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: operationId in: path description: GUID of the operation. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get NetworkTraces for a site: $ref: ./examples/GetWebSiteNetworkTraces.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword: post: tags: - WebApps summary: >- Microsoft Azure Generates A New Publishing Password For An App Or Deployment Slot, If Specified description: >- Description for Generates a new publishing password for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsGeneratenewsitepublishingpassword parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully generate new password. '204': description: Successfully generate new password. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters: get: tags: - WebApps summary: 'Microsoft Azure Gets Perfmon Counters For Web App' description: Description for Gets perfmon counters for web app. operationId: microsoftAzureWebappsListperfmoncounters parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true responses: '200': description: OK schema: $ref: '#/definitions/PerfMonCounterCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging: get: tags: - WebApps summary: 'Microsoft Azure Gets Web App S Event Logs' description: Description for Gets web app's event logs. operationId: microsoftAzureWebappsGetsitephperrorlogflag parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SitePhpErrorLogFlag' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons: get: tags: - WebApps summary: 'Microsoft Azure Gets The Premier Add Ons Of An App' description: Description for Gets the premier add-ons of an app. operationId: microsoftAzureWebappsListpremieraddons parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PremierAddOn' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName} : get: tags: - WebApps summary: 'Microsoft Azure Gets A Named Add On Of An App' description: Description for Gets a named add-on of an app. operationId: microsoftAzureWebappsGetpremieraddon parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: premierAddOnName in: path description: Add-on name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PremierAddOn' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Updates A Named Add On Of An App' description: Description for Updates a named add-on of an app. operationId: microsoftAzureWebappsAddpremieraddon parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: premierAddOnName in: path description: Add-on name. required: true type: string - name: premierAddOn in: body description: A JSON representation of the edited premier add-on. required: true schema: $ref: '#/definitions/PremierAddOn' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PremierAddOn' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Premier Add On From An App' description: Description for Delete a premier add-on from an app. operationId: microsoftAzureWebappsDeletepremieraddon parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: premierAddOnName in: path description: Add-on name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted premier add-on. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: 'Microsoft Azure Updates A Named Add On Of An App' description: Description for Updates a named add-on of an app. operationId: microsoftAzureWebappsUpdatepremieraddon parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: premierAddOnName in: path description: Add-on name. required: true type: string - name: premierAddOn in: body description: A JSON representation of the edited premier add-on. required: true schema: $ref: '#/definitions/PremierAddOnPatchResource' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PremierAddOn' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks : get: tags: - WebApps summary: >- Microsoft Azure Gets Data Around Private Site Access Enablement And Authorized Virtual Networks That Can Access The Site description: >- Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site. operationId: microsoftAzureWebappsGetprivateaccess parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PrivateAccess' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: >- Microsoft Azure Sets Data Around Private Site Access Enablement And Authorized Virtual Networks That Can Access The Site description: >- Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site. operationId: microsoftAzureWebappsPutprivateaccessvnet parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: access in: body description: The information for the private access required: true schema: $ref: '#/definitions/PrivateAccess' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PrivateAccess' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections : get: tags: - WebApps summary: Microsoft Azure 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 operationId: microsoftAzureWebappsGetprivateendpointconnectionlist parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: >- ./CommonDefinitions.json#/definitions/PrivateEndpointConnectionCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - WebApps summary: Microsoft Azure Gets A Private Endpoint Connection description: Description for Gets a private endpoint connection operationId: microsoftAzureWebappsGetprivateendpointconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: >- ./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get a private endpoint connection for a site.: $ref: ./examples/GetSitePrivateEndpointConnection.json put: tags: - WebApps summary: Microsoft Azure Approves Or Rejects A Private Endpoint Connection description: Description for Approves or rejects a private endpoint connection operationId: microsoftAzureWebappsApproveorrejectprivateendpointconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - name: privateEndpointConnectionName in: path required: true type: string - name: privateEndpointWrapper in: body required: true schema: $ref: >- ./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: >- ./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource '202': description: Asynchronous operation in progress. schema: $ref: >- ./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Approves or rejects a private endpoint connection for a site.: $ref: ./examples/ApproveRejectSitePrivateEndpointConnection.json x-ms-long-running-operation: true delete: tags: - WebApps summary: Microsoft Azure Deletes A Private Endpoint Connection description: Description for Deletes a private endpoint connection operationId: microsoftAzureWebappsDeleteprivateendpointconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - name: privateEndpointConnectionName in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: type: object '202': description: Asynchronous operation in progress. schema: type: object '204': description: No content. schema: type: object default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Delete a private endpoint connection for a site.: $ref: ./examples/DeleteSitePrivateEndpointConnection.json x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateLinkResources : get: tags: - WebApps summary: Microsoft Azure Gets The Private Link Resources description: Description for Gets the private link resources operationId: microsoftAzureWebappsGetprivatelinkresources parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/PrivateLinkResourcesWrapper default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get private link resources of a site: $ref: ./examples/GetSitePrivateLinkResources.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes: get: tags: - WebApps summary: >- Microsoft Azure Get List Of Processes For A Web Site, Or A Deployment Slot, Or For A Specific Scaled Out Instance In A Web Site description: >- Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListprocesses parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Process terminated. schema: $ref: '#/definitions/ProcessInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId} : get: tags: - WebApps summary: >- Microsoft Azure Get Process Information By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get process information by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetprocess parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Process information returned. schema: $ref: '#/definitions/ProcessInfo' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: >- Microsoft Azure Terminate A Process By Its Id For A Web Site, Or A Deployment Slot, Or Specific Scaled Out Instance In A Web Site description: >- Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site. operationId: microsoftAzureWebappsDeleteprocess parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Process terminated. '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump : get: tags: - WebApps summary: >- Microsoft Azure Get A Memory Dump Of A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetprocessdump parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules : get: tags: - WebApps summary: >- Microsoft Azure List Module Information For A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for List module information for a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListprocessmodules parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Module information returned. schema: $ref: '#/definitions/ProcessModuleInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress} : get: tags: - WebApps summary: >- Microsoft Azure Get Process Information By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get process information by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetprocessmodule parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: baseAddress in: path description: Module base address. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Module information returned. schema: $ref: '#/definitions/ProcessModuleInfo' '404': description: >- Process with the specified ID is not running, or a module with the specified baseAddress was not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads : get: tags: - WebApps summary: >- Microsoft Azure List The Threads In A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for List the threads in a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListprocessthreads parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Thread information returned. schema: $ref: '#/definitions/ProcessThreadInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates: get: tags: - WebApps summary: 'Microsoft Azure Get Public Certificates For An App Or A Deployment Slot' description: Description for Get public certificates for an app or a deployment slot. operationId: microsoftAzureWebappsListpubliccertificates parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PublicCertificateCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName} : get: tags: - WebApps summary: >- Microsoft Azure Get The Named Public Certificate For An App Or Deployment Slot, If Specified description: >- Description for Get the named public certificate for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsGetpubliccertificate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: publicCertificateName in: path description: Public certificate name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PublicCertificate' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Creates A Hostname Binding For An App' description: Description for Creates a hostname binding for an app. operationId: microsoftAzureWebappsCreateorupdatepubliccertificate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: publicCertificateName in: path description: Public certificate name. required: true type: string - name: publicCertificate in: body description: >- Public certificate details. This is the JSON representation of a PublicCertificate object. required: true schema: $ref: '#/definitions/PublicCertificate' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PublicCertificate' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Hostname Binding For An App' description: Description for Deletes a hostname binding for an app. operationId: microsoftAzureWebappsDeletepubliccertificate parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: publicCertificateName in: path description: Public certificate name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted hostname binding. '204': description: Hostname binding does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml: post: tags: - WebApps summary: 'Microsoft Azure Gets The Publishing Profile For An App Or Deployment Slot, If Specified' description: >- Description for Gets the publishing profile for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsListpublishingprofilexmlwithsecrets produces: - application/xml parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: publishingProfileOptions in: body description: >- Specifies publishingProfileOptions for publishing profile. For example, use {"format": "FileZilla3"} to get a FileZilla publishing profile. required: true schema: $ref: '#/definitions/CsmPublishingProfileOptions' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig: post: tags: - WebApps summary: >- Microsoft Azure Resets The Configuration Settings Of The Current Slot If They Were Previously Modified By Calling The Api With Post description: >- Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST. operationId: microsoftAzureWebappsResetproductionslotconfig parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart: post: tags: - WebApps summary: 'Microsoft Azure Restarts An App Or Deployment Slot, If Specified' description: Description for Restarts an app (or deployment slot, if specified). operationId: microsoftAzureWebappsRestart parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: softRestart in: query description: >- Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app. type: boolean - name: synchronous in: query description: >- Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous). type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully restarted app. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob : post: tags: - WebApps summary: 'Microsoft Azure Restores An App From A Backup Blob In Azure Storage' description: Description for Restores an app from a backup blob in Azure Storage. operationId: microsoftAzureWebappsRestorefrombackupblob parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: request in: body description: Information on restore request . required: true schema: $ref: '#/definitions/RestoreRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Restore operation started. '202': description: Restore operation started. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp : post: tags: - WebApps summary: 'Microsoft Azure Restores A Deleted Web App To This Web App' description: Description for Restores a deleted web app to this web app. operationId: microsoftAzureWebappsRestorefromdeletedapp parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: restoreRequest in: body description: Deleted web app restore information. required: true schema: $ref: '#/definitions/DeletedAppRestoreRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Restore operation started. '202': description: Restore operation started. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot: post: tags: - WebApps summary: 'Microsoft Azure Restores A Web App From A Snapshot' description: Description for Restores a web app from a snapshot. operationId: microsoftAzureWebappsRestoresnapshot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: restoreRequest in: body description: >- Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. required: true schema: $ref: '#/definitions/SnapshotRestoreRequest' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Restore operation started. '202': description: Restore operation started. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions: get: tags: - WebApps summary: 'Microsoft Azure Get List Of Siteextensions For A Web Site, Or A Deployment Slot' description: >- Description for Get list of siteextensions for a web site, or a deployment slot. operationId: microsoftAzureWebappsListsiteextensions parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: SiteExtension information returned. schema: $ref: '#/definitions/SiteExtensionInfoCollection' '404': description: SiteExtension not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId} : get: tags: - WebApps summary: >- Microsoft Azure Get Site Extension Information By Its Id For A Web Site, Or A Deployment Slot description: >- Description for Get site extension information by its ID for a web site, or a deployment slot. operationId: microsoftAzureWebappsGetsiteextension parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: siteExtensionId in: path description: Site extension name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: SiteExtension information returned. schema: $ref: '#/definitions/SiteExtensionInfo' '404': description: SiteExtension with an ID of {siteExtensionId} is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Install Site Extension On A Web Site, Or A Deployment Slot' description: >- Description for Install site extension on a web site, or a deployment slot. operationId: microsoftAzureWebappsInstallsiteextension parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: siteExtensionId in: path description: Site extension name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Site Extension created. schema: $ref: '#/definitions/SiteExtensionInfo' '201': description: Site Extension created. schema: $ref: '#/definitions/SiteExtensionInfo' '429': description: >- Site Extension is being installed on another request: Rejecting current request. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true delete: tags: - WebApps summary: 'Microsoft Azure Remove A Site Extension From A Web Site, Or A Deployment Slot' description: >- Description for Remove a site extension from a web site, or a deployment slot. operationId: microsoftAzureWebappsDeletesiteextension parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: siteExtensionId in: path description: Site extension name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: SiteExtension terminated. '404': description: SiteExtension with an ID of {siteExtensionId} is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots: get: tags: - WebApps summary: 'Microsoft Azure Gets An App S Deployment Slots' description: Description for Gets an app's deployment slots. operationId: microsoftAzureWebappsListslots parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/WebAppCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: List Web App Slots: $ref: ./examples/ListWebAppSlots.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}: get: tags: - WebApps summary: 'Microsoft Azure Gets The Details Of A Web, Mobile, Or Api App' description: Description for Gets the details of a web, mobile, or API app. operationId: microsoftAzureWebappsGetslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. By default, this API returns the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: ./CommonDefinitions.json#/definitions/Site '404': description: Not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Web App Slot: $ref: ./examples/GetWebAppSlot.json put: tags: - WebApps summary: >- Microsoft Azure Creates A New Web, Mobile, Or Api App In An Existing Resource Group, Or Updates An Existing App description: >- Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. operationId: microsoftAzureWebappsCreateorupdateslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: >- Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. required: true type: string - name: siteEnvelope in: body description: A JSON representation of the app properties. See example. required: true schema: $ref: ./CommonDefinitions.json#/definitions/Site - name: slot in: path description: >- Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: ./CommonDefinitions.json#/definitions/Site '202': description: Asynchronous operation in progress. schema: $ref: ./CommonDefinitions.json#/definitions/Site default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Create or Update Web App Slot: $ref: ./examples/CreateOrUpdateWebAppSlot.json Clone web app slot: $ref: ./examples/CloneWebAppSlot.json x-ms-long-running-operation: true delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Web, Mobile, Or Api App, Or One Of The Deployment Slots' description: >- Description for Deletes a web, mobile, or API app, or one of the deployment slots. operationId: microsoftAzureWebappsDeleteslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app to delete. required: true type: string - name: slot in: path description: >- Name of the deployment slot to delete. By default, the API deletes the production slot. required: true type: string - name: deleteMetrics in: query description: If true, web app metrics are also deleted. type: boolean - name: deleteEmptyServerFarm in: query description: >- Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted. type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted web app. '204': description: Successfully deleted web app. '404': description: Web app not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Delete Web App Slot: $ref: ./examples/DeleteWebAppSlot.json patch: tags: - WebApps summary: >- Microsoft Azure Creates A New Web, Mobile, Or Api App In An Existing Resource Group, Or Updates An Existing App description: >- Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app. operationId: microsoftAzureWebappsUpdateslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: >- Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter. required: true type: string - name: siteEnvelope in: body description: A JSON representation of the app properties. See example. required: true schema: $ref: '#/definitions/SitePatchResource' - name: slot in: path description: >- Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: ./CommonDefinitions.json#/definitions/Site '202': description: Asynchronous operation in progress. schema: $ref: ./CommonDefinitions.json#/definitions/Site default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update Web App Slot: $ref: ./examples/UpdateWebAppSlot.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname : get: tags: - WebApps summary: 'Microsoft Azure Analyze A Custom Hostname' description: Description for Analyze a custom hostname. operationId: microsoftAzureWebappsAnalyzecustomhostnameslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: hostName in: query description: Custom hostname. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CustomHostnameAnalysisResult' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse 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: tags: - WebApps summary: >- Microsoft Azure Applies The Configuration Settings From The Target Slot Onto The Current Slot description: >- Description for Applies the configuration settings from the target slot onto the current slot. operationId: microsoftAzureWebappsApplyslotconfigurationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slotSwapEntity in: body description: JSON object that contains the target slot name. See example. required: true schema: $ref: '#/definitions/CsmSlotEntity' - name: slot in: path description: >- Name of the source slot. If a slot is not specified, the production slot is used as the source slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup : post: tags: - WebApps summary: 'Microsoft Azure Creates A Backup Of An App' description: Description for Creates a backup of an app. operationId: microsoftAzureWebappsBackupslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: request in: body description: >- Backup configuration. You can use the JSON response from the POST action as input here. required: true schema: $ref: '#/definitions/BackupRequest' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups : get: tags: - WebApps summary: 'Microsoft Azure Gets Existing Backups Of An App' description: Description for Gets existing backups of an app. operationId: microsoftAzureWebappsListbackupsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItemCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId} : get: tags: - WebApps summary: 'Microsoft Azure Gets A Backup Of An App By Its Id' description: Description for Gets a backup of an app by its ID. operationId: microsoftAzureWebappsGetbackupstatusslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: backupId in: path description: ID of the backup. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Backup Of An App By Its Id' description: Description for Deletes a backup of an app by its ID. operationId: microsoftAzureWebappsDeletebackupslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: backupId in: path description: ID of the backup. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted web app backup item. '404': description: Web app backup item does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list : post: tags: - WebApps summary: >- Microsoft Azure Gets Status Of A Web App Backup That May Be In Progress, Including Secrets Associated With The Backup, Such As The Azure Storage Sas Url Also Can Be Used To Update The Sas Url For The Backup If A New Url Is Passed In The Request Body description: >- Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body. operationId: microsoftAzureWebappsListbackupstatussecretsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: backupId in: path description: ID of backup. required: true type: string - name: request in: body description: Information on backup request. required: true schema: $ref: '#/definitions/BackupRequest' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItem' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore : post: tags: - WebApps summary: >- Microsoft Azure Restores A Specific Backup To Another App Or Deployment Slot, If Specified description: >- Description for Restores a specific backup to another app (or deployment slot, if specified). operationId: microsoftAzureWebappsRestoreslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: backupId in: path description: ID of the backup. required: true type: string - name: request in: body description: Information on restore request . required: true schema: $ref: '#/definitions/RestoreRequest' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Restore operation started. '202': description: Restore operation started. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies : get: tags: - WebApps summary: >- Microsoft Azure Returns Whether Scm Basic Auth Is Allowed And Whether Ftp Is Allowed For A Given Site description: >- Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site. operationId: microsoftAzureWebappsListbasicpublishingcredentialspoliciesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PublishingCredentialsPoliciesCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Publishing Credentials Policies: $ref: ./examples/ListPublishingCredentialsPoliciesSlot.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/ftp : get: tags: - WebApps summary: 'Microsoft Azure Returns Whether Ftp Is Allowed On The Site Or Not' description: Description for Returns whether FTP is allowed on the site or not. operationId: microsoftAzureWebappsGetftpallowedslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get FTP Allowed: $ref: ./examples/GetPublishingCredentialsPolicySlot.json put: tags: - WebApps summary: 'Microsoft Azure Updates Whether Ftp Is Allowed On The Site Or Not' description: Description for Updates whether FTP is allowed on the site or not. operationId: microsoftAzureWebappsUpdateftpallowedslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: csmPublishingAccessPoliciesEntity in: body required: true schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update FTP Allowed: $ref: ./examples/UpdatePublishingCredentialsPolicySlot.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm : get: tags: - WebApps summary: 'Microsoft Azure Returns Whether Scm Basic Auth Is Allowed On The Site Or Not' description: >- Description for Returns whether Scm basic auth is allowed on the site or not. operationId: microsoftAzureWebappsGetscmallowedslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get SCM Allowed: $ref: ./examples/GetPublishingCredentialsPolicySlot.json put: tags: - WebApps summary: >- Microsoft Azure Updates Whether User Publishing Credentials Are Allowed On The Site Or Not description: >- Description for Updates whether user publishing credentials are allowed on the site or not. operationId: microsoftAzureWebappsUpdatescmallowedslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: csmPublishingAccessPoliciesEntity in: body required: true schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Update SCM Allowed: $ref: ./examples/UpdatePublishingCredentialsPolicySlot.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config : get: tags: - WebApps summary: Microsoft Azure List The Configurations Of An App description: Description for List the configurations of an app operationId: microsoftAzureWebappsListconfigurationsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResourceCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings : put: tags: - WebApps summary: 'Microsoft Azure Replaces The Application Settings Of An App' description: Description for Replaces the application settings of an app. operationId: microsoftAzureWebappsUpdateapplicationsettingsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: appSettings in: body description: Application settings of the app. required: true schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Application Settings Of An App' description: Description for Gets the application settings of an app. operationId: microsoftAzureWebappsListapplicationsettingsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings : put: tags: - WebApps summary: >- Microsoft Azure Updates The Authentication Authorization Settings Associated With Web App description: >- Description for Updates the Authentication / Authorization settings associated with web app. operationId: microsoftAzureWebappsUpdateauthsettingsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: siteAuthSettings in: body description: Auth settings associated with web app. required: true schema: $ref: '#/definitions/SiteAuthSettings' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Authentication Authorization Settings Of An App' description: >- Description for Gets the Authentication/Authorization settings of an app. operationId: microsoftAzureWebappsGetauthsettingsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettings' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2 : get: tags: - WebApps summary: >- Microsoft Azure Gets Site S Authentication Authorization Settings For Apps Via The Format operationId: microsoftAzureWebappsGetauthsettingsv2withoutsecretsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettingsV2' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse description: Needs a more full description created. put: tags: - WebApps summary: >- Microsoft Azure Updates Site S Authentication Authorization Settings For Apps Via The Format description: >- Description for Updates site's Authentication / Authorization settings for apps via the V2 format operationId: microsoftAzureWebappsUpdateauthsettingsv2slot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: siteAuthSettingsV2 in: body description: Auth settings associated with web app. required: true schema: $ref: '#/definitions/SiteAuthSettingsV2' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettingsV2' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list : get: tags: - WebApps summary: >- Microsoft Azure Gets Site S Authentication Authorization Settings For Apps Via The Format description: >- Description for Gets site's Authentication / Authorization settings for apps via the V2 format operationId: microsoftAzureWebappsGetauthsettingsv2slot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteAuthSettingsV2' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts : put: tags: - WebApps summary: 'Microsoft Azure Updates The Azure Storage Account Configurations Of An App' description: >- Description for Updates the Azure storage account configurations of an app. operationId: microsoftAzureWebappsUpdateazurestorageaccountsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: azureStorageAccounts in: body description: Azure storage accounts of the app. required: true schema: $ref: '#/definitions/AzureStoragePropertyDictionaryResource' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AzureStoragePropertyDictionaryResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Azure Storage Account Configurations Of An App' description: Description for Gets the Azure storage account configurations of an app. operationId: microsoftAzureWebappsListazurestorageaccountsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AzureStoragePropertyDictionaryResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup : put: tags: - WebApps summary: 'Microsoft Azure Updates The Backup Configuration Of An App' description: Description for Updates the backup configuration of an app. operationId: microsoftAzureWebappsUpdatebackupconfigurationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: request in: body description: Edited backup configuration. required: true schema: $ref: '#/definitions/BackupRequest' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes The Backup Configuration Of An App' description: Description for Deletes the backup configuration of an app. operationId: microsoftAzureWebappsDeletebackupconfigurationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted backup configuration. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Backup Configuration Of An App' description: Description for Gets the backup configuration of an app. operationId: microsoftAzureWebappsGetbackupconfigurationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupRequest' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings : get: tags: - WebApps summary: Microsoft Azure 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 operationId: microsoftAzureWebappsGetappsettingskeyvaultreferencesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ApiKVReferenceCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Azure Key Vault references for app settings for slot: $ref: ./examples/GetKeyVaultReferencesForAppSettingsSlot.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings/{appSettingKey} : get: tags: - WebApps summary: Microsoft Azure Gets The Config Reference And Status Of An App description: Description for Gets the config reference and status of an app operationId: microsoftAzureWebappsGetappsettingkeyvaultreferenceslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: appSettingKey in: path description: App Setting key name. required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ApiKVReference' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Azure Key Vault slot app setting reference: $ref: ./examples/GetKeyVaultReferencesForAppSettingSlot.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings : get: tags: - WebApps summary: Microsoft Azure 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 operationId: microsoftAzureWebappsGetsiteconnectionstringkeyvaultreferencesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ApiKVReferenceCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings/{connectionStringKey} : get: tags: - WebApps summary: Microsoft Azure Gets The Config Reference And Status Of An App description: Description for Gets the config reference and status of an app operationId: microsoftAzureWebappsGetsiteconnectionstringkeyvaultreferenceslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: connectionStringKey in: path required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ApiKVReference' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings : put: tags: - WebApps summary: 'Microsoft Azure Replaces The Connection Strings Of An App' description: Description for Replaces the connection strings of an app. operationId: microsoftAzureWebappsUpdateconnectionstringsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: connectionStrings in: body description: Connection strings of the app or deployment slot. See example. required: true schema: $ref: '#/definitions/ConnectionStringDictionary' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Connection Strings Of An App' description: Description for Gets the connection strings of an app. operationId: microsoftAzureWebappsListconnectionstringsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ConnectionStringDictionary' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs : get: tags: - WebApps summary: 'Microsoft Azure Gets The Logging Configuration Of An App' description: Description for Gets the logging configuration of an app. operationId: microsoftAzureWebappsGetdiagnosticlogsconfigurationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Updates The Logging Configuration Of An App' description: Description for Updates the logging configuration of an app. operationId: microsoftAzureWebappsUpdatediagnosticlogsconfigslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteLogsConfig in: body description: >- A SiteLogsConfig JSON object that contains the logging configuration to change in the "properties" property. required: true schema: $ref: '#/definitions/SiteLogsConfig' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteLogsConfig' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata : put: tags: - WebApps summary: 'Microsoft Azure Replaces The Metadata Of An App' description: Description for Replaces the metadata of an app. operationId: microsoftAzureWebappsUpdatemetadataslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: metadata in: body description: Edited metadata of the app or deployment slot. See example. required: true schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Metadata Of An App' description: Description for Gets the metadata of an app. operationId: microsoftAzureWebappsListmetadataslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Git Ftp Publishing Credentials Of An App' description: Description for Gets the Git/FTP publishing credentials of an app. operationId: microsoftAzureWebappsListpublishingcredentialsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/User default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings : put: tags: - WebApps summary: 'Microsoft Azure Updates The Push Settings Associated With Web App' description: Description for Updates the Push settings associated with web app. operationId: microsoftAzureWebappsUpdatesitepushsettingsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: pushSettings in: body description: Push settings associated with web app. required: true schema: $ref: ./CommonDefinitions.json#/definitions/PushSettings - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/PushSettings default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list : post: tags: - WebApps summary: 'Microsoft Azure Gets The Push Settings Associated With Web App' description: Description for Gets the Push settings associated with web app. operationId: microsoftAzureWebappsListsitepushsettingsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/PushSettings default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web : get: tags: - WebApps summary: >- Microsoft Azure Gets The Configuration Of An App, Such As Platform Version And Bitness, Default Documents, Virtual Applications, Always On, Etc description: >- Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc. operationId: microsoftAzureWebappsGetconfigurationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Updates The Configuration Of An App' description: Description for Updates the configuration of an app. operationId: microsoftAzureWebappsCreateorupdateconfigurationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteConfig in: body description: JSON representation of a SiteConfig object. See example. required: true schema: $ref: '#/definitions/SiteConfigResource' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: 'Microsoft Azure Updates The Configuration Of An App' description: Description for Updates the configuration of an app. operationId: microsoftAzureWebappsUpdateconfigurationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteConfig in: body description: JSON representation of a SiteConfig object. See example. required: true schema: $ref: '#/definitions/SiteConfigResource' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots : get: tags: - WebApps summary: >- Microsoft Azure Gets A List Of Web App Configuration Snapshots Identifiers Each Element Of The List Contains A Timestamp And The Id Of The Snapshot description: >- Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot. operationId: microsoftAzureWebappsListconfigurationsnapshotinfoslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigurationSnapshotInfoCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Snapshot Of The Configuration Of An App At A Previous Point In Time description: >- Description for Gets a snapshot of the configuration of an app at a previous point in time. operationId: microsoftAzureWebappsGetconfigurationsnapshotslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: snapshotId in: path description: The ID of the snapshot to read. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteConfigResource' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover : post: tags: - WebApps summary: 'Microsoft Azure Reverts The Configuration Of An App To A Previous Snapshot' description: >- Description for Reverts the configuration of an app to a previous snapshot. operationId: microsoftAzureWebappsRecoversiteconfigurationsnapshotslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: snapshotId in: path description: The ID of the snapshot to read. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs : post: tags: - WebApps summary: Microsoft Azure Gets The Last Lines Of Docker Logs For The Given Site description: Description for Gets the last lines of docker logs for the given site operationId: microsoftAzureWebappsGetwebsitecontainerlogsslot produces: - application/octet-stream parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download : post: tags: - WebApps summary: Microsoft Azure Gets The Zip Archived Docker Log Files For The Given Site description: >- Description for Gets the ZIP archived docker log files for the given site operationId: microsoftAzureWebappsGetcontainerlogszipslot produces: - application/zip parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs : get: tags: - WebApps summary: 'Microsoft Azure List Continuous Web Jobs For An App, Or A Deployment Slot' description: >- Description for List continuous web jobs for an app, or a deployment slot. operationId: microsoftAzureWebappsListcontinuouswebjobsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ContinuousWebJobCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName} : get: tags: - WebApps summary: 'Microsoft Azure Gets A Continuous Web Job By Its Id For An App, Or A Deployment Slot' description: >- Description for Gets a continuous web job by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsGetcontinuouswebjobslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. schema: $ref: '#/definitions/ContinuousWebJob' '404': description: Continuous web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Continuous Web Job By Its Id For An App, Or A Deployment Slot' description: >- Description for Delete a continuous web job by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsDeletecontinuouswebjobslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted continuous web job. '204': description: Continuous web job does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start : post: tags: - WebApps summary: 'Microsoft Azure Start A Continuous Web Job For An App, Or A Deployment Slot' description: >- Description for Start a continuous web job for an app, or a deployment slot. operationId: microsoftAzureWebappsStartcontinuouswebjobslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. '404': description: Continuous web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop : post: tags: - WebApps summary: 'Microsoft Azure Stop A Continuous Web Job For An App, Or A Deployment Slot' description: >- Description for Stop a continuous web job for an app, or a deployment slot. operationId: microsoftAzureWebappsStopcontinuouswebjobslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. '404': description: Continuous web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus : get: tags: - WebApps summary: 'Microsoft Azure List Deployment Statuses For An App Or Deployment Slot, If Specified' operationId: microsoftAzureWebappsListslotsitedeploymentstatusesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmDeploymentStatusCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List Deployment Status Slot: $ref: ./examples/ListSiteDeploymentStatusSlot.json x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus/{deploymentStatusId} : get: tags: - WebApps summary: 'Microsoft Azure Gets The Deployment Status For An App Or Deployment Slot, If Specified' operationId: microsoftAzureWebappsGetslotsitedeploymentstatusslot parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot. required: true type: string - name: deploymentStatusId in: path description: GUID of the deployment operation. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmDeploymentStatus' '202': description: Operation is in progress. schema: $ref: '#/definitions/CsmDeploymentStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get Deployment Status Slot: $ref: ./examples/GetSiteDeploymentStatusSlot.json x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments : get: tags: - WebApps summary: 'Microsoft Azure List Deployments For An App, Or A Deployment Slot' description: Description for List deployments for an app, or a deployment slot. operationId: microsoftAzureWebappsListdeploymentsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/DeploymentCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id} : get: tags: - WebApps summary: 'Microsoft Azure Get A Deployment By Its Id For An App, Or A Deployment Slot' description: >- Description for Get a deployment by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsGetdeploymentslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: id in: path description: Deployment ID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Create A Deployment For An App, Or A Deployment Slot' description: Description for Create a deployment for an app, or a deployment slot. operationId: microsoftAzureWebappsCreatedeploymentslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: id in: path description: ID of an existing deployment. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot. required: true type: string - name: deployment in: body description: Deployment details. required: true schema: $ref: '#/definitions/Deployment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Deployment By Its Id For An App, Or A Deployment Slot' description: >- Description for Delete a deployment by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsDeletedeploymentslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: id in: path description: Deployment ID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted deployment. '204': description: Deployment does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log : get: tags: - WebApps summary: >- Microsoft Azure List Deployment Log For Specific Deployment For An App, Or A Deployment Slot description: >- Description for List deployment log for specific deployment for an app, or a deployment slot. operationId: microsoftAzureWebappsListdeploymentlogslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: id in: path description: >- The ID of a specific deployment. This is the value of the name property in the JSON response from "GET /api/sites/{siteName}/deployments". required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Deployment' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup : post: tags: - WebApps summary: >- Microsoft Azure Discovers An Existing App Backup That Can Be Restored From A Blob In Azure Storage Use This To Get Information About The Databases Stored In A Backup description: >- Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup. operationId: microsoftAzureWebappsDiscoverbackupslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: request in: body description: >- A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup. required: true schema: $ref: '#/definitions/RestoreRequest' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RestoreRequest' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers : get: tags: - WebApps summary: 'Microsoft Azure Lists Ownership Identifiers For Domain Associated With Web App' description: >- Description for Lists ownership identifiers for domain associated with web app. operationId: microsoftAzureWebappsListdomainownershipidentifiersslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/IdentifierCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName} : get: tags: - WebApps summary: 'Microsoft Azure Get Domain Ownership Identifier For Web App' description: Description for Get domain ownership identifier for web app. operationId: microsoftAzureWebappsGetdomainownershipidentifierslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/Identifier default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: >- Microsoft Azure Creates A Domain Ownership Identifier For Web App, Or Updates An Existing Ownership Identifier description: >- Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier. operationId: microsoftAzureWebappsCreateorupdatedomainownershipidentifierslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true type: string - name: domainOwnershipIdentifier in: body description: A JSON representation of the domain ownership properties. required: true schema: $ref: ./CommonDefinitions.json#/definitions/Identifier - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/Identifier default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Domain Ownership Identifier For A Web App' description: Description for Deletes a domain ownership identifier for a web app. operationId: microsoftAzureWebappsDeletedomainownershipidentifierslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted domain ownership identifier. '204': description: Domain ownership identifier does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: >- Microsoft Azure Creates A Domain Ownership Identifier For Web App, Or Updates An Existing Ownership Identifier description: >- Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier. operationId: microsoftAzureWebappsUpdatedomainownershipidentifierslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: domainOwnershipIdentifierName in: path description: Name of domain ownership identifier. required: true type: string - name: domainOwnershipIdentifier in: body description: A JSON representation of the domain ownership properties. required: true schema: $ref: ./CommonDefinitions.json#/definitions/Identifier - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/Identifier default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy : get: tags: - WebApps summary: 'Microsoft Azure Get The Status Of The Last Msdeploy Operation' description: Description for Get the status of the last MSDeploy operation. operationId: microsoftAzureWebappsGetmsdeploystatusslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MSDeployStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Invoke The Msdeploy Web App Extension' description: Description for Invoke the MSDeploy web app extension. operationId: microsoftAzureWebappsCreatemsdeployoperationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: MSDeploy in: body description: Details of MSDeploy operation required: true schema: $ref: '#/definitions/MSDeploy' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '201': description: Deployment is scheduled. schema: $ref: '#/definitions/MSDeployStatus' '409': description: Another deployment is in progress. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log : get: tags: - WebApps summary: 'Microsoft Azure Get The Msdeploy Log For The Last Msdeploy Operation' description: Description for Get the MSDeploy Log for the last MSDeploy operation. operationId: microsoftAzureWebappsGetmsdeploylogslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: MSDeploy log returned. schema: $ref: '#/definitions/MSDeployLog' '404': description: MSDeploy log not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions : get: tags: - WebApps summary: 'Microsoft Azure List The Functions For A Web Site, Or A Deployment Slot' description: Description for List the functions for a web site, or a deployment slot. operationId: microsoftAzureWebappsListinstancefunctionsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Function information returned. schema: $ref: '#/definitions/FunctionEnvelopeCollection' '404': description: Function with an ID of {functionName} is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token : get: tags: - WebApps summary: 'Microsoft Azure Fetch A Short Lived Token That Can Be Exchanged For A Master Key' description: >- Description for Fetch a short lived token that can be exchanged for a master key. operationId: microsoftAzureWebappsGetfunctionsadmintokenslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: string default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName} : get: tags: - WebApps summary: 'Microsoft Azure Get Function Information By Its Id For Web Site, Or A Deployment Slot' description: >- Description for Get function information by its ID for web site, or a deployment slot. operationId: microsoftAzureWebappsGetinstancefunctionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Function information returned. schema: $ref: '#/definitions/FunctionEnvelope' '404': description: Function with a name of {functionName} does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Create Function For Web Site, Or A Deployment Slot' description: Description for Create function for web site, or a deployment slot. operationId: microsoftAzureWebappsCreateinstancefunctionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - $ref: '#/parameters/slotNameParameter' - name: function_envelope in: body description: Function details. required: true schema: $ref: '#/definitions/FunctionEnvelope' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '201': description: Function created. schema: $ref: '#/definitions/FunctionEnvelope' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true delete: tags: - WebApps summary: 'Microsoft Azure Delete A Function For Web Site, Or A Deployment Slot' description: Description for Delete a function for web site, or a deployment slot. operationId: microsoftAzureWebappsDeleteinstancefunctionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Function deleted. '404': description: Function does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName} : put: tags: - WebApps summary: 'Microsoft Azure Add Or Update A Function Secret' description: Description for Add or update a function secret. operationId: microsoftAzureWebappsCreateorupdatefunctionsecretslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: The name of the function. required: true type: string - name: keyName in: path description: The name of the key. required: true type: string - $ref: '#/parameters/slotNameParameter' - name: key in: body description: The key to create or update required: true schema: $ref: '#/definitions/KeyInfo' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Key was updated. schema: $ref: '#/definitions/KeyInfo' '201': description: Key was created. schema: $ref: '#/definitions/KeyInfo' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Function Secret' description: Description for Delete a function secret. operationId: microsoftAzureWebappsDeletefunctionsecretslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: The name of the function. required: true type: string - name: keyName in: path description: The name of the key. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Key was deleted. '404': description: Key was not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys : post: tags: - WebApps summary: 'Microsoft Azure Get Function Keys For A Function In A Web Site, Or A Deployment Slot' description: >- Description for Get function keys for a function in a web site, or a deployment slot. operationId: microsoftAzureWebappsListfunctionkeysslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Function keys returned. schema: $ref: ./CommonDefinitions.json#/definitions/StringDictionary default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets : post: tags: - WebApps summary: 'Microsoft Azure Get Function Secrets For A Function In A Web Site, Or A Deployment Slot' description: >- Description for Get function secrets for a function in a web site, or a deployment slot. operationId: microsoftAzureWebappsListfunctionsecretsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: functionName in: path description: Function name. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Function secrets returned. schema: $ref: '#/definitions/FunctionSecrets' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys : post: tags: - WebApps summary: 'Microsoft Azure Get Host Secrets For A Function App' description: Description for Get host secrets for a function app. operationId: microsoftAzureWebappsListhostkeysslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Host secrets returned. schema: $ref: '#/definitions/HostKeys' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus : post: tags: - WebApps summary: 'Microsoft Azure This Is To Allow Calling Via Powershell And Arm Template' description: >- Description for This is to allow calling via powershell and ARM template. operationId: microsoftAzureWebappsListsyncstatusslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync : post: tags: - WebApps summary: Microsoft Azure Syncs Function Trigger Metadata To The Management Database description: >- Description for Syncs function trigger metadata to the management database operationId: microsoftAzureWebappsSyncfunctionsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName} : put: tags: - WebApps summary: 'Microsoft Azure Add Or Update A Host Level Secret' description: Description for Add or update a host level secret. operationId: microsoftAzureWebappsCreateorupdatehostsecretslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: keyType in: path description: The type of host key. required: true type: string - name: keyName in: path description: The name of the key. required: true type: string - $ref: '#/parameters/slotNameParameter' - name: key in: body description: The key to create or update required: true schema: $ref: '#/definitions/KeyInfo' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Key was updated. schema: $ref: '#/definitions/KeyInfo' '201': description: Key was created. schema: $ref: '#/definitions/KeyInfo' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Host Level Secret' description: Description for Delete a host level secret. operationId: microsoftAzureWebappsDeletehostsecretslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: keyType in: path description: The type of host key. required: true type: string - name: keyName in: path description: The name of the key. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Key was deleted. '404': description: Key was not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings : get: tags: - WebApps summary: 'Microsoft Azure Get Hostname Bindings For An App Or A Deployment Slot' description: Description for Get hostname bindings for an app or a deployment slot. operationId: microsoftAzureWebappsListhostnamebindingsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBindingCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName} : get: tags: - WebApps summary: >- Microsoft Azure Get The Named Hostname Binding For An App Or Deployment Slot, If Specified description: >- Description for Get the named hostname binding for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsGethostnamebindingslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot. required: true type: string - name: hostName in: path description: Hostname in the hostname binding. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBinding' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Creates A Hostname Binding For An App' description: Description for Creates a hostname binding for an app. operationId: microsoftAzureWebappsCreateorupdatehostnamebindingslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: hostName in: path description: Hostname in the hostname binding. required: true type: string - name: hostNameBinding in: body description: >- Binding details. This is the JSON representation of a HostNameBinding object. required: true schema: $ref: '#/definitions/HostNameBinding' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostNameBinding' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Hostname Binding For An App' description: Description for Deletes a hostname binding for an app. operationId: microsoftAzureWebappsDeletehostnamebindingslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. required: true type: string - name: hostName in: path description: Hostname in the hostname binding. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted hostname binding. '204': description: Hostname binding does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} : get: tags: - WebApps summary: 'Microsoft Azure Retrieves A Specific Service Bus Hybrid Connection Used By This Web App' description: >- Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App. operationId: microsoftAzureWebappsGethybridconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true type: string - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Creates A New Hybrid Connection Using A Service Bus Relay' description: >- Description for Creates a new Hybrid Connection using a Service Bus relay. operationId: microsoftAzureWebappsCreateorupdatehybridconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true type: string - name: connectionEnvelope in: body description: The details of the hybrid connection. required: true schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Removes A Hybrid Connection From This Site' description: Description for Removes a Hybrid Connection from this site. operationId: microsoftAzureWebappsDeletehybridconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true type: string - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted hybrid connection. '404': description: Hybrid connection does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: 'Microsoft Azure Creates A New Hybrid Connection Using A Service Bus Relay' description: >- Description for Creates a new Hybrid Connection using a Service Bus relay. operationId: microsoftAzureWebappsUpdatehybridconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: namespaceName in: path description: The namespace for this hybrid connection. required: true type: string - name: relayName in: path description: The relay name for this hybrid connection. required: true type: string - name: connectionEnvelope in: body description: The details of the hybrid connection. required: true schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays : get: tags: - WebApps summary: 'Microsoft Azure Retrieves All Service Bus Hybrid Connections Used By This Web App' description: >- Description for Retrieves all Service Bus Hybrid Connections used by this Web App. operationId: microsoftAzureWebappsListhybridconnectionsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/HybridConnection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection : get: tags: - WebApps summary: >- Microsoft Azure Gets Hybrid Connections Configured For An App Or Deployment Slot, If Specified description: >- Description for Gets hybrid connections configured for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsListrelayserviceconnectionsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get hybrid connections for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName} : get: tags: - WebApps summary: 'Microsoft Azure Gets A Hybrid Connection Configuration By Its Name' description: Description for Gets a hybrid connection configuration by its name. operationId: microsoftAzureWebappsGetrelayserviceconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: entityName in: path description: Name of the hybrid connection. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: >- Microsoft Azure Creates A New Hybrid Connection Configuration Put , Or Updates An Existing One Patch description: >- Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH). operationId: microsoftAzureWebappsCreateorupdaterelayserviceconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: entityName in: path description: Name of the hybrid connection configuration. required: true type: string - name: connectionEnvelope in: body description: Details of the hybrid connection configuration. required: true schema: $ref: '#/definitions/RelayServiceConnectionEntity' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Relay Service Connection By Its Name' description: Description for Deletes a relay service connection by its name. operationId: microsoftAzureWebappsDeleterelayserviceconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: entityName in: path description: Name of the hybrid connection configuration. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete a hybrid connection for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted relay service connection. '404': description: Relay service connection does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: >- Microsoft Azure Creates A New Hybrid Connection Configuration Put , Or Updates An Existing One Patch description: >- Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH). operationId: microsoftAzureWebappsUpdaterelayserviceconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: entityName in: path description: Name of the hybrid connection configuration. required: true type: string - name: connectionEnvelope in: body description: Details of the hybrid connection configuration. required: true schema: $ref: '#/definitions/RelayServiceConnectionEntity' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RelayServiceConnectionEntity' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances : get: tags: - WebApps summary: 'Microsoft Azure Gets All Scale Out Instances Of An App' description: Description for Gets all scale-out instances of an app. operationId: microsoftAzureWebappsListinstanceidentifiersslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API gets the production slot instances. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WebAppInstanceStatusCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId} : get: tags: - WebApps summary: 'Microsoft Azure Gets All Scale Out Instances Of An App' description: Description for Gets all scale-out instances of an app. operationId: microsoftAzureWebappsGetinstanceinfoslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: instanceId in: path required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API gets the production slot instances. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WebSiteInstanceStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get site instance info: $ref: ./examples/GetSiteInstanceInfo.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy : get: tags: - WebApps summary: 'Microsoft Azure Get The Status Of The Last Msdeploy Operation' description: Description for Get the status of the last MSDeploy operation. operationId: microsoftAzureWebappsGetinstancemsdeploystatusslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: instanceId in: path description: ID of web app instance. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MSDeployStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Invoke The Msdeploy Web App Extension' description: Description for Invoke the MSDeploy web app extension. operationId: microsoftAzureWebappsCreateinstancemsdeployoperationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: instanceId in: path description: ID of web app instance. required: true type: string - name: MSDeploy in: body description: Details of MSDeploy operation required: true schema: $ref: '#/definitions/MSDeploy' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '201': description: Deployment is scheduled. schema: $ref: '#/definitions/MSDeployStatus' '409': description: Another deployment is in progress. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log : get: tags: - WebApps summary: 'Microsoft Azure Get The Msdeploy Log For The Last Msdeploy Operation' description: Description for Get the MSDeploy Log for the last MSDeploy operation. operationId: microsoftAzureWebappsGetinstancemsdeploylogslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - name: instanceId in: path description: ID of web app instance. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: MSDeploy log returned. schema: $ref: '#/definitions/MSDeployLog' '404': description: MSDeploy log not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes : get: tags: - WebApps summary: >- Microsoft Azure Get List Of Processes For A Web Site, Or A Deployment Slot, Or For A Specific Scaled Out Instance In A Web Site description: >- Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListinstanceprocessesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Process terminated. schema: $ref: '#/definitions/ProcessInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId} : get: tags: - WebApps summary: >- Microsoft Azure Get Process Information By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get process information by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetinstanceprocessslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Process information returned. schema: $ref: '#/definitions/ProcessInfo' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: >- Microsoft Azure Terminate A Process By Its Id For A Web Site, Or A Deployment Slot, Or Specific Scaled Out Instance In A Web Site description: >- Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site. operationId: microsoftAzureWebappsDeleteinstanceprocessslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Process terminated. '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump : get: tags: - WebApps summary: >- Microsoft Azure Get A Memory Dump Of A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetinstanceprocessdumpslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules : get: tags: - WebApps summary: >- Microsoft Azure List Module Information For A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for List module information for a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListinstanceprocessmodulesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Module information returned. schema: $ref: '#/definitions/ProcessModuleInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress} : get: tags: - WebApps summary: >- Microsoft Azure Get Process Information By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get process information by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetinstanceprocessmoduleslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: baseAddress in: path description: Module base address. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Module information returned. schema: $ref: '#/definitions/ProcessModuleInfo' '404': description: >- Process with the specified ID is not running, or a module with the specified baseAddress was not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads : get: tags: - WebApps summary: >- Microsoft Azure List The Threads In A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for List the threads in a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListinstanceprocessthreadsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - name: instanceId in: path description: >- ID of a specific scaled-out instance. This is the value of the name property in the JSON response from "GET api/sites/{siteName}/instances". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Thread information returned. schema: $ref: '#/definitions/ProcessThreadInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable : post: tags: - WebApps summary: >- Microsoft Azure Shows Whether An App Can Be Cloned To Another Resource Group Or Subscription description: >- Description for Shows whether an app can be cloned to another resource group or subscription. operationId: microsoftAzureWebappsIscloneableslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. By default, this API returns information on the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/SiteCloneability' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listbackups : post: tags: - WebApps summary: 'Microsoft Azure Gets Existing Backups Of An App' description: Description for Gets existing backups of an app. operationId: microsoftAzureWebappsListsitebackupsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/BackupItemCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List backups: $ref: ./examples/ListSlotBackups.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus : post: tags: - WebApps summary: 'Microsoft Azure This Is To Allow Calling Via Powershell And Arm Template' description: >- Description for This is to allow calling via powershell and ARM template. operationId: microsoftAzureWebappsListsyncfunctiontriggersslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/FunctionSecrets' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status : get: tags: - WebApps summary: >- Microsoft Azure Returns The Status Of Mysql In App Migration, If One Is Active, And Whether Or Not Mysql In App Is Enabled description: >- Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled operationId: microsoftAzureWebappsGetmigratemysqlstatusslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MigrateMySqlStatus' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork : get: tags: - WebApps summary: 'Microsoft Azure Gets A Swift Virtual Network Connection' description: Description for Gets a Swift Virtual Network connection. operationId: microsoftAzureWebappsGetswiftvirtualnetworkconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/SwiftVirtualNetwork' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: "Microsoft Azure Integrates This Web App With A Virtual Network This Requires That 1 \"swiftsupported\" Is True When Doing A Get Against This Resource, And 2 That The Target Subnet Has Already Been Delegated, And Is Not\r\nin Use By Another App Service Plan Other Than The One This App Is In" description: >- Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not
in use by another App Service Plan other than the one this App is in. operationId: >- microsoftAzureWebappsCreateorupdateswiftvirtualnetworkconnectionwithcheckslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: connectionEnvelope in: body description: Properties of the Virtual Network connection. See example. required: true schema: $ref: '#/definitions/SwiftVirtualNetwork' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SwiftVirtualNetwork' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: >- Microsoft Azure Deletes A Swift Virtual Network Connection From An App Or Deployment Slot description: >- Description for Deletes a Swift Virtual Network connection from an app (or deployment slot). operationId: microsoftAzureWebappsDeleteswiftvirtualnetworkslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted virtual network. '404': description: Virtual network does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: "Microsoft Azure Integrates This Web App With A Virtual Network This Requires That 1 \"swiftsupported\" Is True When Doing A Get Against This Resource, And 2 That The Target Subnet Has Already Been Delegated, And Is Not\r\nin Use By Another App Service Plan Other Than The One This App Is In" description: >- Description for Integrates this Web App with a Virtual Network. This requires that 1) "swiftSupported" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not
in use by another App Service Plan other than the one this App is in. operationId: microsoftAzureWebappsUpdateswiftvirtualnetworkconnectionwithcheckslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: connectionEnvelope in: body description: Properties of the Virtual Network connection. See example. required: true schema: $ref: '#/definitions/SwiftVirtualNetwork' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SwiftVirtualNetwork' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view} : get: tags: - WebApps summary: >- Microsoft Azure Gets All Network Features Used By The App Or Deployment Slot, If Specified description: >- Description for Gets all network features used by the app (or deployment slot, if specified). operationId: microsoftAzureWebappsListnetworkfeaturesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: view in: path description: The type of view. Only "summary" is supported at this time. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: '#/definitions/NetworkFeatures' '404': description: The requested view does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Named Operation For A Network Trace Capturing Or Deployment Slot, If Specified description: >- Description for Gets a named operation for a network trace capturing (or deployment slot, if specified). operationId: microsoftAzureWebappsGetnetworktraceoperationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: operationId in: path description: GUID of the operation. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' '202': description: Operation is in progress. schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get the current status of a network trace operation for a site: $ref: ./examples/GetWebSiteNetworkTraceOperation.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start : post: tags: - WebApps summary: 'Microsoft Azure Start Capturing Network Packets For The Site To Be Deprecated' description: >- Description for Start capturing network packets for the site (To be deprecated). operationId: microsoftAzureWebappsStartwebsitenetworktraceslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. type: integer format: int32 - name: slot in: path description: The name of the slot for this web app. required: true type: string - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: string default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/startOperation : post: tags: - WebApps summary: 'Microsoft Azure Start Capturing Network Packets For The Site' description: Description for Start capturing network packets for the site. operationId: microsoftAzureWebappsStartwebsitenetworktraceoperationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. type: integer format: int32 - name: slot in: path description: The name of the slot for this web app. required: true type: string - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' '202': description: Operation is in progress. schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Start a new network trace operation for a site: $ref: ./examples/StartWebSiteNetworkTraceOperation.json x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop : post: tags: - WebApps summary: 'Microsoft Azure Stop Ongoing Capturing Network Packets For The Site' description: Description for Stop ongoing capturing network packets for the site. operationId: microsoftAzureWebappsStopwebsitenetworktraceslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Stopped. '204': description: Stopped. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Stop a currently running network trace operation for a site: $ref: ./examples/StopWebSiteNetworkTrace.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Named Operation For A Network Trace Capturing Or Deployment Slot, If Specified description: >- Description for Gets a named operation for a network trace capturing (or deployment slot, if specified). operationId: microsoftAzureWebappsGetnetworktracesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: operationId in: path description: GUID of the operation. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get NetworkTraces for a site: $ref: ./examples/GetWebSiteNetworkTraces.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Named Operation For A Network Trace Capturing Or Deployment Slot, If Specified description: >- Description for Gets a named operation for a network trace capturing (or deployment slot, if specified). operationId: microsoftAzureWebappsGetnetworktraceoperationslotv2 parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: operationId in: path description: GUID of the operation. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' '202': description: Operation is in progress. schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get the current status of a network trace operation for a site: $ref: ./examples/GetWebSiteNetworkTraceOperation.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Named Operation For A Network Trace Capturing Or Deployment Slot, If Specified description: >- Description for Gets a named operation for a network trace capturing (or deployment slot, if specified). operationId: microsoftAzureWebappsGetnetworktracesslotv2 parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: operationId in: path description: GUID of the operation. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get NetworkTraces for a site: $ref: ./examples/GetWebSiteNetworkTraces.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword : post: tags: - WebApps summary: >- Microsoft Azure Generates A New Publishing Password For An App Or Deployment Slot, If Specified description: >- Description for Generates a new publishing password for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsGeneratenewsitepublishingpasswordslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API generate a new publishing password for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully generate new password. '204': description: Successfully generate new password. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters : get: tags: - WebApps summary: 'Microsoft Azure Gets Perfmon Counters For Web App' description: Description for Gets perfmon counters for web app. operationId: microsoftAzureWebappsListperfmoncountersslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - name: $filter in: query description: >- Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true responses: '200': description: OK schema: $ref: '#/definitions/PerfMonCounterCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging : get: tags: - WebApps summary: 'Microsoft Azure Gets Web App S Event Logs' description: Description for Gets web app's event logs. operationId: microsoftAzureWebappsGetsitephperrorlogflagslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SitePhpErrorLogFlag' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons : get: tags: - WebApps summary: 'Microsoft Azure Gets The Premier Add Ons Of An App' description: Description for Gets the premier add-ons of an app. operationId: microsoftAzureWebappsListpremieraddonsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PremierAddOn' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName} : get: tags: - WebApps summary: 'Microsoft Azure Gets A Named Add On Of An App' description: Description for Gets a named add-on of an app. operationId: microsoftAzureWebappsGetpremieraddonslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: premierAddOnName in: path description: Add-on name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PremierAddOn' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Updates A Named Add On Of An App' description: Description for Updates a named add-on of an app. operationId: microsoftAzureWebappsAddpremieraddonslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: premierAddOnName in: path description: Add-on name. required: true type: string - name: premierAddOn in: body description: A JSON representation of the edited premier add-on. required: true schema: $ref: '#/definitions/PremierAddOn' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PremierAddOn' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Premier Add On From An App' description: Description for Delete a premier add-on from an app. operationId: microsoftAzureWebappsDeletepremieraddonslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: premierAddOnName in: path description: Add-on name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted premier add-on. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: 'Microsoft Azure Updates A Named Add On Of An App' description: Description for Updates a named add-on of an app. operationId: microsoftAzureWebappsUpdatepremieraddonslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: premierAddOnName in: path description: Add-on name. required: true type: string - name: premierAddOn in: body description: A JSON representation of the edited premier add-on. required: true schema: $ref: '#/definitions/PremierAddOnPatchResource' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PremierAddOn' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks : get: tags: - WebApps summary: >- Microsoft Azure Gets Data Around Private Site Access Enablement And Authorized Virtual Networks That Can Access The Site description: >- Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site. operationId: microsoftAzureWebappsGetprivateaccessslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PrivateAccess' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: >- Microsoft Azure Sets Data Around Private Site Access Enablement And Authorized Virtual Networks That Can Access The Site description: >- Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site. operationId: microsoftAzureWebappsPutprivateaccessvnetslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: access in: body description: The information for the private access required: true schema: $ref: '#/definitions/PrivateAccess' - name: slot in: path description: The name of the slot for the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PrivateAccess' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections : get: tags: - WebApps summary: Microsoft Azure 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 operationId: microsoftAzureWebappsGetprivateendpointconnectionlistslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - name: slot in: path description: Name of the site deployment slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: >- ./CommonDefinitions.json#/definitions/PrivateEndpointConnectionCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName} : get: tags: - WebApps summary: Microsoft Azure Gets A Private Endpoint Connection description: Description for Gets a private endpoint connection operationId: microsoftAzureWebappsGetprivateendpointconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - name: privateEndpointConnectionName in: path description: Name of the private endpoint connection. required: true type: string - name: slot in: path description: Name of the site deployment slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: >- ./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get a private endpoint connection for a site.: $ref: ./examples/GetSitePrivateEndpointConnectionSlot.json put: tags: - WebApps summary: Microsoft Azure Approves Or Rejects A Private Endpoint Connection description: Description for Approves or rejects a private endpoint connection operationId: microsoftAzureWebappsApproveorrejectprivateendpointconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - name: privateEndpointConnectionName in: path required: true type: string - name: privateEndpointWrapper in: body required: true schema: $ref: >- ./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: >- ./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource '202': description: Asynchronous operation in progress. schema: $ref: >- ./CommonDefinitions.json#/definitions/RemotePrivateEndpointConnectionARMResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Approves or rejects a private endpoint connection for a site.: $ref: ./examples/ApproveRejectSitePrivateEndpointConnectionSlot.json x-ms-long-running-operation: true delete: tags: - WebApps summary: Microsoft Azure Deletes A Private Endpoint Connection description: Description for Deletes a private endpoint connection operationId: microsoftAzureWebappsDeleteprivateendpointconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - name: privateEndpointConnectionName in: path required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: type: object '202': description: Asynchronous operation in progress. schema: type: object '204': description: No content. schema: type: object default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Delete a private endpoint connection for a site.: $ref: ./examples/DeleteSitePrivateEndpointConnectionSlot.json x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateLinkResources : get: tags: - WebApps summary: Microsoft Azure Gets The Private Link Resources description: Description for Gets the private link resources operationId: microsoftAzureWebappsGetprivatelinkresourcesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the site. required: true type: string - name: slot in: path required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/PrivateLinkResourcesWrapper default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Get private link resources of a site: $ref: ./examples/GetSitePrivateLinkResourcesSlot.json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes : get: tags: - WebApps summary: >- Microsoft Azure Get List Of Processes For A Web Site, Or A Deployment Slot, Or For A Specific Scaled Out Instance In A Web Site description: >- Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListprocessesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Process terminated. schema: $ref: '#/definitions/ProcessInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId} : get: tags: - WebApps summary: >- Microsoft Azure Get Process Information By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get process information by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetprocessslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Process information returned. schema: $ref: '#/definitions/ProcessInfo' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: >- Microsoft Azure Terminate A Process By Its Id For A Web Site, Or A Deployment Slot, Or Specific Scaled Out Instance In A Web Site description: >- Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site. operationId: microsoftAzureWebappsDeleteprocessslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Process terminated. '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump : get: tags: - WebApps summary: >- Microsoft Azure Get A Memory Dump Of A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetprocessdumpslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules : get: tags: - WebApps summary: >- Microsoft Azure List Module Information For A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for List module information for a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListprocessmodulesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Module information returned. schema: $ref: '#/definitions/ProcessModuleInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress} : get: tags: - WebApps summary: >- Microsoft Azure Get Process Information By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for Get process information by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsGetprocessmoduleslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: baseAddress in: path description: Module base address. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Module information returned. schema: $ref: '#/definitions/ProcessModuleInfo' '404': description: >- Process with the specified ID is not running, or a module with the specified baseAddress was not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads : get: tags: - WebApps summary: >- Microsoft Azure List The Threads In A Process By Its Id For A Specific Scaled Out Instance In A Web Site description: >- Description for List the threads in a process by its ID for a specific scaled-out instance in a web site. operationId: microsoftAzureWebappsListprocessthreadsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: processId in: path description: PID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Thread information returned. schema: $ref: '#/definitions/ProcessThreadInfoCollection' '404': description: Process with the specified ID is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates : get: tags: - WebApps summary: 'Microsoft Azure Get Public Certificates For An App Or A Deployment Slot' description: Description for Get public certificates for an app or a deployment slot. operationId: microsoftAzureWebappsListpubliccertificatesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PublicCertificateCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName} : get: tags: - WebApps summary: >- Microsoft Azure Get The Named Public Certificate For An App Or Deployment Slot, If Specified description: >- Description for Get the named public certificate for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsGetpubliccertificateslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot. required: true type: string - name: publicCertificateName in: path description: Public certificate name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PublicCertificate' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Creates A Hostname Binding For An App' description: Description for Creates a hostname binding for an app. operationId: microsoftAzureWebappsCreateorupdatepubliccertificateslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: publicCertificateName in: path description: Public certificate name. required: true type: string - name: publicCertificate in: body description: >- Public certificate details. This is the JSON representation of a PublicCertificate object. required: true schema: $ref: '#/definitions/PublicCertificate' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/PublicCertificate' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Deletes A Hostname Binding For An App' description: Description for Deletes a hostname binding for an app. operationId: microsoftAzureWebappsDeletepubliccertificateslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot. required: true type: string - name: publicCertificateName in: path description: Public certificate name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted hostname binding. '204': description: Hostname binding does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml : post: tags: - WebApps summary: 'Microsoft Azure Gets The Publishing Profile For An App Or Deployment Slot, If Specified' description: >- Description for Gets the publishing profile for an app (or deployment slot, if specified). operationId: microsoftAzureWebappsListpublishingprofilexmlwithsecretsslot produces: - application/xml parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: publishingProfileOptions in: body description: >- Specifies publishingProfileOptions for publishing profile. For example, use {"format": "FileZilla3"} to get a FileZilla publishing profile. required: true schema: $ref: '#/definitions/CsmPublishingProfileOptions' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the publishing profile for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: file default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig : post: tags: - WebApps summary: >- Microsoft Azure Resets The Configuration Settings Of The Current Slot If They Were Previously Modified By Calling The Api With Post description: >- Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST. operationId: microsoftAzureWebappsResetslotconfigurationslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API resets configuration settings for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart : post: tags: - WebApps summary: 'Microsoft Azure Restarts An App Or Deployment Slot, If Specified' description: Description for Restarts an app (or deployment slot, if specified). operationId: microsoftAzureWebappsRestartslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will restart the production slot. required: true type: string - name: softRestart in: query description: >- Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app. type: boolean - name: synchronous in: query description: >- Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous). type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully restarted app. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob : post: tags: - WebApps summary: 'Microsoft Azure Restores An App From A Backup Blob In Azure Storage' description: Description for Restores an app from a backup blob in Azure Storage. operationId: microsoftAzureWebappsRestorefrombackupblobslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: request in: body description: Information on restore request . required: true schema: $ref: '#/definitions/RestoreRequest' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Restore operation started. '202': description: Restore operation started. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp : post: tags: - WebApps summary: 'Microsoft Azure Restores A Deleted Web App To This Web App' description: Description for Restores a deleted web app to this web app. operationId: microsoftAzureWebappsRestorefromdeletedappslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: restoreRequest in: body description: Deleted web app restore information. required: true schema: $ref: '#/definitions/DeletedAppRestoreRequest' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Restore operation started. '202': description: Restore operation started. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot : post: tags: - WebApps summary: 'Microsoft Azure Restores A Web App From A Snapshot' description: Description for Restores a web app from a snapshot. operationId: microsoftAzureWebappsRestoresnapshotslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: restoreRequest in: body description: >- Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API. required: true schema: $ref: '#/definitions/SnapshotRestoreRequest' - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Restore operation started. '202': description: Restore operation started. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions : get: tags: - WebApps summary: 'Microsoft Azure Get List Of Siteextensions For A Web Site, Or A Deployment Slot' description: >- Description for Get list of siteextensions for a web site, or a deployment slot. operationId: microsoftAzureWebappsListsiteextensionsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API uses the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: SiteExtension information returned. schema: $ref: '#/definitions/SiteExtensionInfoCollection' '404': description: SiteExtension not found. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId} : get: tags: - WebApps summary: >- Microsoft Azure Get Site Extension Information By Its Id For A Web Site, Or A Deployment Slot description: >- Description for Get site extension information by its ID for a web site, or a deployment slot. operationId: microsoftAzureWebappsGetsiteextensionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: siteExtensionId in: path description: Site extension name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API uses the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: SiteExtension information returned. schema: $ref: '#/definitions/SiteExtensionInfo' '404': description: SiteExtension with an ID of {siteExtensionId} is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Install Site Extension On A Web Site, Or A Deployment Slot' description: >- Description for Install site extension on a web site, or a deployment slot. operationId: microsoftAzureWebappsInstallsiteextensionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: siteExtensionId in: path description: Site extension name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API uses the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Site Extension created. schema: $ref: '#/definitions/SiteExtensionInfo' '201': description: Site Extension created. schema: $ref: '#/definitions/SiteExtensionInfo' '429': description: >- Site Extension is being installed on another request: Rejecting current request. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true delete: tags: - WebApps summary: 'Microsoft Azure Remove A Site Extension From A Web Site, Or A Deployment Slot' description: >- Description for Remove a site extension from a web site, or a deployment slot. operationId: microsoftAzureWebappsDeletesiteextensionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: siteExtensionId in: path description: Site extension name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: SiteExtension terminated. '404': description: SiteExtension with an ID of {siteExtensionId} is not running. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs : post: tags: - WebApps summary: 'Microsoft Azure Get The Difference In Configuration Settings Between Two Web App Slots' description: >- Description for Get the difference in configuration settings between two web app slots. operationId: microsoftAzureWebappsListslotdifferencesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slotSwapEntity in: body description: JSON object that contains the target slot name. See example. required: true schema: $ref: '#/definitions/CsmSlotEntity' - name: slot in: path description: >- Name of the source slot. If a slot is not specified, the production slot is used as the source slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotDifferenceCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap : post: tags: - WebApps summary: 'Microsoft Azure Swaps Two Deployment Slots Of An App' description: Description for Swaps two deployment slots of an app. operationId: microsoftAzureWebappsSwapslotslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slotSwapEntity in: body description: JSON object that contains the target slot name. See example. required: true schema: $ref: '#/definitions/CsmSlotEntity' - name: slot in: path description: >- Name of the source slot. If a slot is not specified, the production slot is used as the source slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. '202': description: Operation is in progress. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots : get: tags: - WebApps summary: 'Microsoft Azure Returns All Snapshots To The User' description: Description for Returns all Snapshots to the user. operationId: microsoftAzureWebappsListsnapshotsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Website Name. required: true type: string - name: slot in: path description: Website Slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SnapshotCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr : get: tags: - WebApps summary: 'Microsoft Azure Returns All Snapshots To The User From Drsecondary Endpoint' description: >- Description for Returns all Snapshots to the user from DRSecondary endpoint. operationId: microsoftAzureWebappsListsnapshotsfromdrsecondaryslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Website Name. required: true type: string - name: slot in: path description: Website Slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SnapshotCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web : get: tags: - WebApps summary: 'Microsoft Azure Gets The Source Control Configuration Of An App' description: Description for Gets the source control configuration of an app. operationId: microsoftAzureWebappsGetsourcecontrolslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully retrieved source control for web app. schema: $ref: '#/definitions/SiteSourceControl' '201': description: Create or update source control for web app still in progress. schema: $ref: '#/definitions/SiteSourceControl' '202': description: Create or update source control for web app still in progress. schema: $ref: '#/definitions/SiteSourceControl' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Updates The Source Control Configuration Of An App' description: Description for Updates the source control configuration of an app. operationId: microsoftAzureWebappsCreateorupdatesourcecontrolslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteSourceControl in: body description: JSON representation of a SiteSourceControl object. See example. required: true schema: $ref: '#/definitions/SiteSourceControl' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully created or updated source control for web app. schema: $ref: '#/definitions/SiteSourceControl' '201': description: Create or update source control for web app in progress. schema: $ref: '#/definitions/SiteSourceControl' '202': description: Create or update source control for web app in progress. schema: $ref: '#/definitions/SiteSourceControl' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true delete: tags: - WebApps summary: 'Microsoft Azure Deletes The Source Control Configuration Of An App' description: Description for Deletes the source control configuration of an app. operationId: microsoftAzureWebappsDeletesourcecontrolslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the source control configuration for the production slot. required: true type: string - name: additionalFlags in: query type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted source control for web app. '202': description: Source control delete operation in progress. '404': description: Source control does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: 'Microsoft Azure Updates The Source Control Configuration Of An App' description: Description for Updates the source control configuration of an app. operationId: microsoftAzureWebappsUpdatesourcecontrolslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteSourceControl in: body description: JSON representation of a SiteSourceControl object. See example. required: true schema: $ref: '#/definitions/SiteSourceControl' - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully created or updated source control for web app. schema: $ref: '#/definitions/SiteSourceControl' '201': description: Create or update source control for web app in progress. schema: $ref: '#/definitions/SiteSourceControl' '202': description: Create or update source control for web app in progress. schema: $ref: '#/definitions/SiteSourceControl' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start: post: tags: - WebApps summary: 'Microsoft Azure Starts An App Or Deployment Slot, If Specified' description: Description for Starts an app (or deployment slot, if specified). operationId: microsoftAzureWebappsStartslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will start the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully started app. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/startNetworkTrace : post: tags: - WebApps summary: 'Microsoft Azure Start Capturing Network Packets For The Site' description: Description for Start capturing network packets for the site. operationId: microsoftAzureWebappsStartnetworktraceslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. type: integer format: int32 - name: slot in: path description: The name of the slot for this web app. required: true type: string - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' '202': description: Operation is in progress. schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Start a new network trace operation for a site: $ref: ./examples/StartWebSiteNetworkTraceOperation.json x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop: post: tags: - WebApps summary: 'Microsoft Azure Stops An App Or Deployment Slot, If Specified' description: Description for Stops an app (or deployment slot, if specified). operationId: microsoftAzureWebappsStopslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will stop the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully stopped app. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stopNetworkTrace : post: tags: - WebApps summary: 'Microsoft Azure Stop Ongoing Capturing Network Packets For The Site' description: Description for Stop ongoing capturing network packets for the site. operationId: microsoftAzureWebappsStopnetworktraceslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: slot in: path description: The name of the slot for this web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Stopped. '204': description: Stopped. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Stop a currently running network trace operation for a site: $ref: ./examples/StopWebSiteNetworkTrace.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync: post: tags: - WebApps summary: 'Microsoft Azure Sync Web App Repository' description: Description for Sync web app repository. operationId: microsoftAzureWebappsSyncrepositoryslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - name: slot in: path description: >- Name of web app slot. If not specified then will default to production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully sync source control. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers : post: tags: - WebApps summary: Microsoft Azure Syncs Function Trigger Metadata To The Management Database description: >- Description for Syncs function trigger metadata to the management database operationId: microsoftAzureWebappsSyncfunctiontriggersslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs : get: tags: - WebApps summary: 'Microsoft Azure List Triggered Web Jobs For An App, Or A Deployment Slot' description: >- Description for List triggered web jobs for an app, or a deployment slot. operationId: microsoftAzureWebappsListtriggeredwebjobsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/TriggeredWebJobCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName} : get: tags: - WebApps summary: 'Microsoft Azure Gets A Triggered Web Job By Its Id For An App, Or A Deployment Slot' description: >- Description for Gets a triggered web job by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsGettriggeredwebjobslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API uses the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. schema: $ref: '#/definitions/TriggeredWebJob' '404': description: Triggered web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Triggered Web Job By Its Id For An App, Or A Deployment Slot' description: >- Description for Delete a triggered web job by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsDeletetriggeredwebjobslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API deletes web job for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted continuous web job. '204': description: Triggered web job does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history : get: tags: - WebApps summary: 'Microsoft Azure List A Triggered Web Job S History For An App, Or A Deployment Slot' description: >- Description for List a triggered web job's history for an app, or a deployment slot. operationId: microsoftAzureWebappsListtriggeredwebjobhistoryslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API uses the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. schema: $ref: '#/definitions/TriggeredJobHistoryCollection' '404': description: Triggered web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Triggered Web Job S History By Its Id For An App, , Or A Deployment Slot description: >- Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot. operationId: microsoftAzureWebappsGettriggeredwebjobhistoryslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: id in: path description: History ID. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API uses the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. schema: $ref: '#/definitions/TriggeredJobHistory' '404': description: Triggered web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run : post: tags: - WebApps summary: 'Microsoft Azure Run A Triggered Web Job For An App, Or A Deployment Slot' description: >- Description for Run a triggered web job for an app, or a deployment slot. operationId: microsoftAzureWebappsRuntriggeredwebjobslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API uses the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Run a triggered web job. '404': description: Triggered web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages : get: tags: - WebApps summary: >- Microsoft Azure Gets The Quota Usage Information Of An App Or Deployment Slot, If Specified description: >- Description for Gets the quota usage information of an app (or deployment slot, if specified). operationId: microsoftAzureWebappsListusagesslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get quota information of the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - name: $filter in: query description: >- Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections : get: tags: - WebApps summary: 'Microsoft Azure Gets The Virtual Networks The App Or Deployment Slot Is Connected To' description: >- Description for Gets the virtual networks the app (or deployment slot) is connected to. operationId: microsoftAzureWebappsListvnetconnectionsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Virtual Network The App Or Deployment Slot Is Connected To By Name description: >- Description for Gets a virtual network the app (or deployment slot) is connected to by name. operationId: microsoftAzureWebappsGetvnetconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the virtual network. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: >- Microsoft Azure Adds A Virtual Network Connection To An App Or Slot Put Or Updates The Connection Properties Patch description: >- Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH). operationId: microsoftAzureWebappsCreateorupdatevnetconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of an existing Virtual Network. required: true type: string - name: connectionEnvelope in: body description: Properties of the Virtual Network connection. See example. required: true schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: >- Microsoft Azure Deletes A Connection From An App Or Deployment Slot To A Named Virtual Network description: >- Description for Deletes a connection from an app (or deployment slot to a named virtual network. operationId: microsoftAzureWebappsDeletevnetconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the virtual network. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted virtual network. '404': description: Virtual network does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: >- Microsoft Azure Adds A Virtual Network Connection To An App Or Slot Put Or Updates The Connection Properties Patch description: >- Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH). operationId: microsoftAzureWebappsUpdatevnetconnectionslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of an existing Virtual Network. required: true type: string - name: connectionEnvelope in: body description: Properties of the Virtual Network connection. See example. required: true schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} : get: tags: - WebApps summary: 'Microsoft Azure Gets An App S Virtual Network Gateway' description: Description for Gets an app's Virtual Network gateway. operationId: microsoftAzureWebappsGetvnetconnectiongatewayslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the Virtual Network. required: true type: string - name: gatewayName in: path description: >- Name of the gateway. Currently, the only supported string is "primary". required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway '404': description: >- Named gateway does not exist. Only the "primary" gateway is supported currently. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Adds A Gateway To A Connected Virtual Network Put Or Updates It Patch' description: >- Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH). operationId: microsoftAzureWebappsCreateorupdatevnetconnectiongatewayslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the Virtual Network. required: true type: string - name: gatewayName in: path description: >- Name of the gateway. Currently, the only supported string is "primary". required: true type: string - name: connectionEnvelope in: body description: The properties to update this gateway with. required: true schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: 'Microsoft Azure Adds A Gateway To A Connected Virtual Network Put Or Updates It Patch' description: >- Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH). operationId: microsoftAzureWebappsUpdatevnetconnectiongatewayslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the Virtual Network. required: true type: string - name: gatewayName in: path description: >- Name of the gateway. Currently, the only supported string is "primary". required: true type: string - name: connectionEnvelope in: body description: The properties to update this gateway with. required: true schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs : get: tags: - WebApps summary: 'Microsoft Azure List Webjobs For An App, Or A Deployment Slot' description: Description for List webjobs for an app, or a deployment slot. operationId: microsoftAzureWebappsListwebjobsslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WebJobCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName} : get: tags: - WebApps summary: 'Microsoft Azure Get Webjob Information For An App, Or A Deployment Slot' description: Description for Get webjob information for an app, or a deployment slot. operationId: microsoftAzureWebappsGetwebjobslot parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of the web job. required: true type: string - name: slot in: path description: >- Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WebJob' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs: post: tags: - WebApps summary: 'Microsoft Azure Get The Difference In Configuration Settings Between Two Web App Slots' description: >- Description for Get the difference in configuration settings between two web app slots. operationId: microsoftAzureWebappsListslotdifferencesfromproduction parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slotSwapEntity in: body description: JSON object that contains the target slot name. See example. required: true schema: $ref: '#/definitions/CsmSlotEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SlotDifferenceCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap: post: tags: - WebApps summary: 'Microsoft Azure Swaps Two Deployment Slots Of An App' description: Description for Swaps two deployment slots of an app. operationId: microsoftAzureWebappsSwapslotwithproduction parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: slotSwapEntity in: body description: JSON object that contains the target slot name. See example. required: true schema: $ref: '#/definitions/CsmSlotEntity' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. '202': description: Operation is in progress. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots: get: tags: - WebApps summary: 'Microsoft Azure Returns All Snapshots To The User' description: Description for Returns all Snapshots to the user. operationId: microsoftAzureWebappsListsnapshots parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Website Name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SnapshotCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr: get: tags: - WebApps summary: 'Microsoft Azure Returns All Snapshots To The User From Drsecondary Endpoint' description: >- Description for Returns all Snapshots to the user from DRSecondary endpoint. operationId: microsoftAzureWebappsListsnapshotsfromdrsecondary parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Website Name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SnapshotCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web: get: tags: - WebApps summary: 'Microsoft Azure Gets The Source Control Configuration Of An App' description: Description for Gets the source control configuration of an app. operationId: microsoftAzureWebappsGetsourcecontrol parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully retrieved source control for web app. schema: $ref: '#/definitions/SiteSourceControl' '201': description: Create or update source control for web app still in progress. schema: $ref: '#/definitions/SiteSourceControl' '202': description: Create or update source control for web app still in progress. schema: $ref: '#/definitions/SiteSourceControl' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Updates The Source Control Configuration Of An App' description: Description for Updates the source control configuration of an app. operationId: microsoftAzureWebappsCreateorupdatesourcecontrol parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteSourceControl in: body description: JSON representation of a SiteSourceControl object. See example. required: true schema: $ref: '#/definitions/SiteSourceControl' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully created or updated source control for web app. schema: $ref: '#/definitions/SiteSourceControl' '201': description: Create or update source control for web app in progress. schema: $ref: '#/definitions/SiteSourceControl' '202': description: Create or update source control for web app in progress. schema: $ref: '#/definitions/SiteSourceControl' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-long-running-operation: true delete: tags: - WebApps summary: 'Microsoft Azure Deletes The Source Control Configuration Of An App' description: Description for Deletes the source control configuration of an app. operationId: microsoftAzureWebappsDeletesourcecontrol parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: additionalFlags in: query type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted source control for web app. '202': description: Source control delete operation in progress. '404': description: Source control does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: 'Microsoft Azure Updates The Source Control Configuration Of An App' description: Description for Updates the source control configuration of an app. operationId: microsoftAzureWebappsUpdatesourcecontrol parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: siteSourceControl in: body description: JSON representation of a SiteSourceControl object. See example. required: true schema: $ref: '#/definitions/SiteSourceControl' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully created or updated source control for web app. schema: $ref: '#/definitions/SiteSourceControl' '201': description: Create or update source control for web app in progress. schema: $ref: '#/definitions/SiteSourceControl' '202': description: Create or update source control for web app in progress. schema: $ref: '#/definitions/SiteSourceControl' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start: post: tags: - WebApps summary: 'Microsoft Azure Starts An App Or Deployment Slot, If Specified' description: Description for Starts an app (or deployment slot, if specified). operationId: microsoftAzureWebappsStart parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully started app. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/startNetworkTrace: post: tags: - WebApps summary: 'Microsoft Azure Start Capturing Network Packets For The Site' description: Description for Start capturing network packets for the site. operationId: microsoftAzureWebappsStartnetworktrace parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - name: durationInSeconds in: query description: The duration to keep capturing in seconds. type: integer format: int32 - name: maxFrameLength in: query description: The maximum frame length in bytes (Optional). type: integer format: int32 - name: sasUrl in: query description: The Blob URL to store capture file. type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/NetworkTrace' '202': description: Operation is in progress. schema: type: array items: $ref: '#/definitions/NetworkTrace' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Start a new network trace operation for a site: $ref: ./examples/StartWebSiteNetworkTraceOperation.json x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop: post: tags: - WebApps summary: 'Microsoft Azure Stops An App Or Deployment Slot, If Specified' description: Description for Stops an app (or deployment slot, if specified). operationId: microsoftAzureWebappsStop parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully stopped app. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stopNetworkTrace: post: tags: - WebApps summary: 'Microsoft Azure Stop Ongoing Capturing Network Packets For The Site' description: Description for Stop ongoing capturing network packets for the site. operationId: microsoftAzureWebappsStopnetworktrace parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: The name of the web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Stopped. '204': description: Stopped. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Stop a currently running network trace operation for a site: $ref: ./examples/StopWebSiteNetworkTrace.json /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync: post: tags: - WebApps summary: 'Microsoft Azure Sync Web App Repository' description: Description for Sync web app repository. operationId: microsoftAzureWebappsSyncrepository parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of web app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully sync source control. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers : post: tags: - WebApps summary: Microsoft Azure Syncs Function Trigger Metadata To The Management Database description: >- Description for Syncs function trigger metadata to the management database operationId: microsoftAzureWebappsSyncfunctiontriggers parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '204': description: No Content default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs: get: tags: - WebApps summary: 'Microsoft Azure List Triggered Web Jobs For An App, Or A Deployment Slot' description: >- Description for List triggered web jobs for an app, or a deployment slot. operationId: microsoftAzureWebappsListtriggeredwebjobs parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/TriggeredWebJobCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName} : get: tags: - WebApps summary: 'Microsoft Azure Gets A Triggered Web Job By Its Id For An App, Or A Deployment Slot' description: >- Description for Gets a triggered web job by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsGettriggeredwebjob parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. schema: $ref: '#/definitions/TriggeredWebJob' '404': description: Triggered web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: 'Microsoft Azure Delete A Triggered Web Job By Its Id For An App, Or A Deployment Slot' description: >- Description for Delete a triggered web job by its ID for an app, or a deployment slot. operationId: microsoftAzureWebappsDeletetriggeredwebjob parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted continuous web job. '204': description: Triggered web job does not exist. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history : get: tags: - WebApps summary: 'Microsoft Azure List A Triggered Web Job S History For An App, Or A Deployment Slot' description: >- Description for List a triggered web job's history for an app, or a deployment slot. operationId: microsoftAzureWebappsListtriggeredwebjobhistory parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. schema: $ref: '#/definitions/TriggeredJobHistoryCollection' '404': description: Triggered web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Triggered Web Job S History By Its Id For An App, , Or A Deployment Slot description: >- Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot. operationId: microsoftAzureWebappsGettriggeredwebjobhistory parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - name: id in: path description: History ID. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Found continuous web job. schema: $ref: '#/definitions/TriggeredJobHistory' '404': description: Triggered web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run : post: tags: - WebApps summary: 'Microsoft Azure Run A Triggered Web Job For An App, Or A Deployment Slot' description: >- Description for Run a triggered web job for an app, or a deployment slot. operationId: microsoftAzureWebappsRuntriggeredwebjob parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of Web Job. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Run a triggered web job. '404': description: Triggered web job does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages: get: tags: - WebApps summary: >- Microsoft Azure Gets The Quota Usage Information Of An App Or Deployment Slot, If Specified description: >- Description for Gets the quota usage information of an app (or deployment slot, if specified). operationId: microsoftAzureWebappsListusages parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' - name: $filter in: query description: >- Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'. type: string x-ms-skip-url-encoding: true responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections : get: tags: - WebApps summary: 'Microsoft Azure Gets The Virtual Networks The App Or Deployment Slot Is Connected To' description: >- Description for Gets the virtual networks the app (or deployment slot) is connected to. operationId: microsoftAzureWebappsListvnetconnections parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName} : get: tags: - WebApps summary: >- Microsoft Azure Gets A Virtual Network The App Or Deployment Slot Is Connected To By Name description: >- Description for Gets a virtual network the app (or deployment slot) is connected to by name. operationId: microsoftAzureWebappsGetvnetconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the virtual network. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: >- Microsoft Azure Adds A Virtual Network Connection To An App Or Slot Put Or Updates The Connection Properties Patch description: >- Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH). operationId: microsoftAzureWebappsCreateorupdatevnetconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of an existing Virtual Network. required: true type: string - name: connectionEnvelope in: body description: Properties of the Virtual Network connection. See example. required: true schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse delete: tags: - WebApps summary: >- Microsoft Azure Deletes A Connection From An App Or Deployment Slot To A Named Virtual Network description: >- Description for Deletes a connection from an app (or deployment slot to a named virtual network. operationId: microsoftAzureWebappsDeletevnetconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the virtual network. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully deleted virtual network. '404': description: Virtual network does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: >- Microsoft Azure Adds A Virtual Network Connection To An App Or Slot Put Or Updates The Connection Properties Patch description: >- Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH). operationId: microsoftAzureWebappsUpdatevnetconnection parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of an existing Virtual Network. required: true type: string - name: connectionEnvelope in: body description: Properties of the Virtual Network connection. See example. required: true schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetInfoResource default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName} : get: tags: - WebApps summary: 'Microsoft Azure Gets An App S Virtual Network Gateway' description: Description for Gets an app's Virtual Network gateway. operationId: microsoftAzureWebappsGetvnetconnectiongateway parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the Virtual Network. required: true type: string - name: gatewayName in: path description: >- Name of the gateway. Currently, the only supported string is "primary". required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK. schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway '404': description: >- Named gateway does not exist. Only the "primary" gateway is supported currently. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse put: tags: - WebApps summary: 'Microsoft Azure Adds A Gateway To A Connected Virtual Network Put Or Updates It Patch' description: >- Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH). operationId: microsoftAzureWebappsCreateorupdatevnetconnectiongateway parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the Virtual Network. required: true type: string - name: gatewayName in: path description: >- Name of the gateway. Currently, the only supported string is "primary". required: true type: string - name: connectionEnvelope in: body description: The properties to update this gateway with. required: true schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse patch: tags: - WebApps summary: 'Microsoft Azure Adds A Gateway To A Connected Virtual Network Put Or Updates It Patch' description: >- Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH). operationId: microsoftAzureWebappsUpdatevnetconnectiongateway parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Name of the app. required: true type: string - name: vnetName in: path description: Name of the Virtual Network. required: true type: string - name: gatewayName in: path description: >- Name of the gateway. Currently, the only supported string is "primary". required: true type: string - name: connectionEnvelope in: body description: The properties to update this gateway with. required: true schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/VnetGateway default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs: get: tags: - WebApps summary: 'Microsoft Azure List Webjobs For An App, Or A Deployment Slot' description: Description for List webjobs for an app, or a deployment slot. operationId: microsoftAzureWebappsListwebjobs parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WebJobCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName} : get: tags: - WebApps summary: 'Microsoft Azure Get Webjob Information For An App, Or A Deployment Slot' description: Description for Get webjob information for an app, or a deployment slot. operationId: microsoftAzureWebappsGetwebjob parameters: - $ref: '#/parameters/resourceGroupNameParameter' - name: name in: path description: Site name. required: true type: string - name: webJobName in: path description: Name of the web job. required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WebJob' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployWorkflowArtifacts : post: tags: - WebApps summary: 'Microsoft Azure Creates The Artifacts For Web Site, Or A Deployment Slot' description: >- Description for Creates the artifacts for web site, or a deployment slot. operationId: microsoftAzureWebappsDeployworkflowartifacts parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - $ref: '#/parameters/apiVersionParameter' - name: workflowArtifacts in: body description: Application settings and files of the workflow. required: false x-ms-secret: true schema: $ref: '#/definitions/WorkflowArtifacts' responses: '200': description: Artifacts deployed. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Deploys workflow artifacts: $ref: ./examples/PostDeployWorkflowArtifacts.json Delete workflow artifacts: $ref: ./examples/DeleteDeployWorkflowArtifacts.json x-ms-long-running-operation: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployWorkflowArtifacts : post: tags: - WebApps summary: 'Microsoft Azure Creates The Artifacts For Web Site, Or A Deployment Slot' description: >- Description for Creates the artifacts for web site, or a deployment slot. operationId: microsoftAzureWebappsDeployworkflowartifactsslot parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/apiVersionParameter' - name: workflowArtifacts in: body description: Application settings and files of the workflow. required: false x-ms-secret: true schema: $ref: '#/definitions/WorkflowArtifacts' responses: '200': description: Artifacts deployed. default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: Deploys workflow artifacts slot: $ref: ./examples/PostDeployWorkflowArtifactsSlot.json x-ms-long-running-operation: false ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows : get: tags: - WebApps summary: 'Microsoft Azure List The Workflows For A Web Site, Or A Deployment Slot' operationId: microsoftAzureWebappsListinstanceworkflowsslot parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Workflow information returned. schema: $ref: '#/definitions/WorkflowEnvelopeCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List the workflows Slot: $ref: ./examples/ListWorkflows.json x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows/{workflowName} : get: tags: - WebApps summary: 'Microsoft Azure Get Workflow Information By Its Id For Web Site, Or A Deployment Slot' operationId: microsoftAzureWebappsGetinstanceworkflowslot parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - $ref: '#/parameters/slotNameParameter' - name: workflowName in: path description: Workflow name. required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Workflow information returned. schema: $ref: '#/definitions/WorkflowEnvelope' '404': description: Workflow with a name of {workflowName} does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: GET a workflow Slot: $ref: ./examples/GetWorkflow.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listWorkflowsConnections : post: tags: - WebApps summary: 'Microsoft Azure Lists Logic App S Connections For Web Site, Or A Deployment Slot' operationId: microsoftAzureWebappsListworkflowsconnectionsslot parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - $ref: '#/parameters/slotNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Connections information returned. schema: $ref: '#/definitions/WorkflowEnvelope' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List the Instance Workflows Configuration Connections Slot: $ref: ./examples/ListWorkflowsConfigurationConnections.json description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows: get: tags: - WebApps summary: 'Microsoft Azure List The Workflows For A Web Site, Or A Deployment Slot' operationId: microsoftAzureWebappsListworkflows parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Workflow information returned. schema: $ref: '#/definitions/WorkflowEnvelopeCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List the workflows: $ref: ./examples/ListWorkflows.json x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows/{workflowName} : get: tags: - WebApps summary: 'Microsoft Azure Get Workflow Information By Its Id For Web Site, Or A Deployment Slot' operationId: microsoftAzureWebappsGetworkflow parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName in: path description: Workflow name. required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Workflow information returned. schema: $ref: '#/definitions/WorkflowEnvelope' '404': description: Workflow with a name of {workflowName} does not exist. x-ms-error-response: true default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: GET a workflow: $ref: ./examples/GetWorkflow.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listWorkflowsConnections : post: tags: - WebApps summary: 'Microsoft Azure Lists Logic App S Connections For Web Site, Or A Deployment Slot' operationId: microsoftAzureWebappsListworkflowsconnections parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Connections information returned. schema: $ref: '#/definitions/WorkflowEnvelope' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-examples: List the Instance Workflows Configuration Connections: $ref: ./examples/ListWorkflowsConfigurationConnections.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/regenerateAccessKey : post: tags: - Workflows operationId: microsoftAzureWorkflowsRegenerateaccesskey description: Regenerates the callback URL access key for request triggers. x-ms-examples: Regenerate the callback URL access key for request triggers: $ref: ./examples/Workflows_RegenerateAccessKey.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: keyType description: The access key type. in: body required: true schema: $ref: '#/definitions/RegenerateActionParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Regenerateaccesskey ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs : get: tags: - WorkflowRuns operationId: microsoftAzureWorkflowrunsList description: Gets a list of workflow runs. x-ms-examples: List workflow runs: $ref: ./examples/WorkflowRuns_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' - name: $top description: The number of items to be included in the result. in: query required: false type: integer format: int32 - name: $filter description: >- The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId. in: query required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/WorkflowRunListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/WorkflowRunFilter' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName} : get: tags: - WorkflowRuns operationId: microsoftAzureWorkflowrunsGet description: Gets a workflow run. x-ms-examples: Get a run for a workflow: $ref: ./examples/WorkflowRuns_Get.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowRun' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions : get: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionsList description: Gets a list of workflow run actions. x-ms-examples: List a workflow run actions: $ref: ./examples/WorkflowRunActions_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' - name: $top description: The number of items to be included in the result. in: query required: false type: integer format: int32 - name: $filter description: >- The filter to apply on the operation. Options for filters include: Status. in: query required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/WorkflowRunActionListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/WorkflowRunActionFilter' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName} : get: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionsGet description: Gets a workflow run action. x-ms-examples: Get a workflow run action: $ref: ./examples/WorkflowRunActions_Get.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - name: actionName description: The workflow action name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowRunAction' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions Actionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces : post: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionsListexpressiontraces description: Lists a workflow run expression trace. x-ms-examples: List expression traces: $ref: ./examples/WorkflowRunActions_ListExpressionTraces.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - name: actionName description: The workflow action name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ExpressionTraces' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink itemName: inputs summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions Actionname Listexpressiontraces ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions : get: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionrepetitionsList description: Get all of a workflow run action repetitions. x-ms-examples: List repetitions: $ref: ./examples/WorkflowRunActionRepetitions_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - name: actionName description: The workflow action name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowRunActionRepetitionDefinitionCollection' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions Actionname Repetitions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName} : get: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionrepetitionsGet description: Get a workflow run action repetition. x-ms-examples: Get a repetition: $ref: ./examples/WorkflowRunActionRepetitions_Get.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - name: actionName description: The workflow action name. in: path required: true type: string - name: repetitionName description: The workflow repetition. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowRunActionRepetitionDefinition' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions Actionname Repetitions Repetitionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces : post: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionrepetitionsListexpressiontraces description: Lists a workflow run expression trace. x-ms-examples: List expression traces for a repetition: $ref: ./examples/WorkflowRunActionRepetitions_ListExpressionTraces.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - name: actionName description: The workflow action name. in: path required: true type: string - name: repetitionName description: The workflow repetition. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ExpressionTraces' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink itemName: inputs summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions Actionname Repetitions Repetitionname Listexpressiontraces ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories : get: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionrepetitionsrequesthistoriesList description: List a workflow run repetition request history. x-ms-examples: List repetition request history: $ref: ./examples/WorkflowRunActionRepetitionsRequestHistories_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - name: actionName description: The workflow action name. in: path required: true type: string - name: repetitionName description: The workflow repetition. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RequestHistoryListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions Actionname Repetitions Repetitionname Requesthistories ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName} : get: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionrepetitionsrequesthistoriesGet description: Gets a workflow run repetition request history. x-ms-examples: Get a repetition request history: $ref: ./examples/WorkflowRunActionRepetitionsRequestHistories_Get.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - name: actionName description: The workflow action name. in: path required: true type: string - name: repetitionName description: The workflow repetition. in: path required: true type: string - name: requestHistoryName description: The request history name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/RequestHistory' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions Actionname Repetitions Repetitionname Requesthistories Requesthistoryname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions : get: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionscoperepetitionsList description: List the workflow run action scoped repetitions. x-ms-examples: List the scoped repetitions: $ref: ./examples/WorkflowRunActionScopeRepetitions_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - name: actionName description: The workflow action name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowRunActionRepetitionDefinitionCollection' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions Actionname Scoperepetitions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName} : get: tags: - WorkflowRunActions operationId: microsoftAzureWorkflowrunactionscoperepetitionsGet description: Get a workflow run action scoped repetition. x-ms-examples: Get a scoped repetition: $ref: ./examples/WorkflowRunActionScopeRepetitions_Get.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - name: actionName description: The workflow action name. in: path required: true type: string - name: repetitionName description: The workflow repetition. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowRunActionRepetitionDefinition' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Actions Actionname Scoperepetitions Repetitionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel : post: tags: - WorkflowRuns operationId: microsoftAzureWorkflowrunsCancel description: Cancels a workflow run. x-ms-examples: Cancel a workflow run: $ref: ./examples/WorkflowRuns_Cancel.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: runName description: The workflow run name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Runs Runname Cancel ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers : get: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersList description: Gets a list of workflow triggers. x-ms-examples: List workflow triggers: $ref: ./examples/WorkflowTriggers_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' - name: $top description: The number of items to be included in the result. in: query required: false type: integer format: int32 - name: $filter description: The filter to apply on the operation. in: query required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTriggerListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/WorkflowTriggerFilter' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName} : get: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersGet description: Gets a workflow trigger. x-ms-examples: Get a workflow trigger: $ref: ./examples/WorkflowTriggers_Get.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTrigger' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories : get: tags: - WorkflowTriggerHistories operationId: microsoftAzureWorkflowtriggerhistoriesList description: Gets a list of workflow trigger histories. x-ms-examples: List a workflow trigger history: $ref: ./examples/WorkflowTriggerHistories_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' - name: $top description: The number of items to be included in the result. in: query required: false type: integer format: int32 - name: $filter description: >- The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId. in: query required: false type: string responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTriggerHistoryListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/WorkflowTriggerHistoryFilter' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername Histories ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName} : get: tags: - WorkflowTriggerHistories operationId: microsoftAzureWorkflowtriggerhistoriesGet description: Gets a workflow trigger history. x-ms-examples: Get a workflow trigger history: $ref: ./examples/WorkflowTriggerHistories_Get.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - name: historyName description: >- The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTriggerHistory' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername Histories Historyname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit : post: tags: - WorkflowTriggerHistories operationId: microsoftAzureWorkflowtriggerhistoriesResubmit description: Resubmits a workflow run based on the trigger history. x-ms-examples: Resubmit a workflow run based on the trigger history: $ref: ./examples/WorkflowTriggerHistories_Resubmit.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - name: historyName description: >- The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '202': description: OK default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername Histories Historyname Resubmit ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl : post: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersListcallbackurl description: Get the callback URL for a workflow trigger. x-ms-examples: Get the callback URL for a trigger: $ref: ./examples/WorkflowTriggers_ListCallbackUrl.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowTriggerCallbackUrl' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername Listcallbackurl ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/run : post: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersRun description: Runs a workflow trigger. x-ms-examples: Run a workflow trigger: $ref: ./examples/WorkflowTriggers_Run.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK '202': description: Accepted default: description: Error response describing why the trigger run failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername Run ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/schemas/json : get: tags: - WorkflowTriggers operationId: microsoftAzureWorkflowtriggersGetschemajson description: Get the trigger schema as JSON. x-ms-examples: Get trigger schema: $ref: ./examples/WorkflowTriggers_GetSchemaJson.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: triggerName description: The workflow trigger name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/JsonSchema' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Triggers Triggername Schemas Json ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/validate : post: tags: - Workflows operationId: microsoftAzureWorkflowsValidate description: Validates the workflow definition. x-ms-examples: Validate a workflow: $ref: ./examples/Workflows_Validate.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: validate description: The workflow. in: body required: true schema: $ref: '#/definitions/Workflow' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Validate ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions : get: tags: - WorkflowVersions operationId: microsoftAzureWorkflowversionsList description: Gets a list of workflow versions. x-ms-examples: List a workflows versions: $ref: ./examples/WorkflowVersions_List.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' - name: $top description: The number of items to be included in the result. in: query required: false type: integer format: int32 responses: '200': description: OK schema: $ref: '#/definitions/WorkflowVersionListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Versions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions/{versionId} : get: tags: - WorkflowVersions operationId: microsoftAzureWorkflowversionsGet description: Gets a workflow version. x-ms-examples: Get a workflow version: $ref: ./examples/WorkflowVersions_Get.json parameters: - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/resourceGroupNameParameter' - $ref: '#/parameters/siteNameParameter' - name: workflowName description: The workflow name. in: path required: true type: string - name: versionId description: The workflow versionId. in: path required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkflowVersion' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Web Sites Name Hostruntime Runtime Webhooks Workflow Api Management Workflows Workflowname Versions Versionid definitions: AllowedAudiencesValidation: description: The configuration settings of the Allowed Audiences validation flow. type: object properties: allowedAudiences: description: >- The configuration settings of the allowed list of audiences from which to validate the JWT token. type: array items: type: string AllowedPrincipals: description: >- The configuration settings of the Azure Active Directory allowed principals. type: object properties: groups: description: The list of the allowed groups. type: array items: type: string identities: description: The list of the allowed identities. type: array items: type: string ApiKVReference: description: Description of site key vault references. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: ApiKVReference resource specific properties type: object properties: reference: type: string status: enum: - Initialized - Resolved - InvalidSyntax - MSINotEnabled - VaultNotFound - SecretNotFound - SecretVersionNotFound - AccessToKeyVaultDenied - OtherReasons - FetchTimedOut - UnauthorizedClient type: string x-ms-enum: name: ResolveStatus modelAsString: false vaultName: type: string secretName: type: string secretVersion: type: string identityType: $ref: ./CommonDefinitions.json#/definitions/ManagedServiceIdentity details: type: string source: enum: - KeyVault type: string x-ms-enum: name: ConfigReferenceSource modelAsString: false activeVersion: type: string x-ms-client-flatten: true ApiKVReferenceCollection: required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/ApiKVReference' nextLink: description: Link to next page of resources. type: string readOnly: true AppRegistration: description: >- The configuration settings of the app registration for providers that have app ids and app secrets type: object properties: appId: description: The App ID of the app used for login. type: string appSecretSettingName: description: The app setting name that contains the app secret. type: string Apple: description: The configuration settings of the Apple provider. type: object properties: enabled: description: >- false if the Apple provider should not be enabled despite the set registration; otherwise, true. type: boolean registration: $ref: '#/definitions/AppleRegistration' description: The configuration settings of the Apple registration. login: $ref: '#/definitions/LoginScopes' description: The configuration settings of the login flow. AppleRegistration: description: The configuration settings of the registration for the Apple provider type: object properties: clientId: description: The Client ID of the app used for login. type: string clientSecretSettingName: description: The app setting name that contains the client secret. type: string ApplicationLogsConfig: description: Application logs configuration. type: object properties: fileSystem: $ref: '#/definitions/FileSystemApplicationLogsConfig' description: Application logs to file system configuration. azureTableStorage: $ref: '#/definitions/AzureTableStorageApplicationLogsConfig' description: Application logs to azure table storage configuration. azureBlobStorage: $ref: '#/definitions/AzureBlobStorageApplicationLogsConfig' description: Application logs to blob storage configuration. AuthPlatform: description: >- The configuration settings of the platform of App Service Authentication/Authorization. type: object properties: enabled: description: >- true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. type: boolean runtimeVersion: description: >- The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. type: string configFilePath: 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. type: string AzureActiveDirectory: description: The configuration settings of the Azure Active directory provider. type: object properties: enabled: description: >- false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. type: boolean registration: $ref: '#/definitions/AzureActiveDirectoryRegistration' description: >- The configuration settings of the Azure Active Directory app registration. login: $ref: '#/definitions/AzureActiveDirectoryLogin' description: The configuration settings of the Azure Active Directory login flow. validation: $ref: '#/definitions/AzureActiveDirectoryValidation' description: >- The configuration settings of the Azure Active Directory token validation flow. isAutoProvisioned: 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. type: boolean AzureActiveDirectoryLogin: description: The configuration settings of the Azure Active Directory login flow. type: object properties: loginParameters: 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". type: array items: type: string disableWWWAuthenticate: description: >- true if the www-authenticate provider should be omitted from the request; otherwise, false. type: boolean AzureActiveDirectoryRegistration: description: The configuration settings of the Azure Active Directory app registration. type: object properties: openIdIssuer: 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 type: string clientId: 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 type: string clientSecretSettingName: description: >- The app setting name that contains the client secret of the relying party application. type: string clientSecretCertificateThumbprint: description: >- An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. type: string clientSecretCertificateSubjectAlternativeName: 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. type: string clientSecretCertificateIssuer: 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. type: string AzureActiveDirectoryValidation: description: >- The configuration settings of the Azure Active Directory token validation flow. type: object properties: jwtClaimChecks: $ref: '#/definitions/JwtClaimChecks' description: >- The configuration settings of the checks that should be made while validating the JWT Claims. allowedAudiences: description: >- The list of audiences that can make successful authentication/authorization requests. type: array items: type: string defaultAuthorizationPolicy: $ref: '#/definitions/DefaultAuthorizationPolicy' description: The configuration settings of the default authorization policy. AzureBlobStorageApplicationLogsConfig: description: Application logs azure blob storage configuration. type: object properties: level: description: Log level. enum: - 'Off' - Verbose - Information - Warning - Error type: string x-ms-enum: name: LogLevel modelAsString: false sasUrl: description: >- SAS url to a azure blob container with read/write/list/delete permissions. type: string retentionInDays: format: int32 description: |- Retention in days. Remove blobs older than X days. 0 or lower means no retention. type: integer AzureBlobStorageHttpLogsConfig: description: Http logs to azure blob storage configuration. type: object properties: sasUrl: description: >- SAS url to a azure blob container with read/write/list/delete permissions. type: string retentionInDays: format: int32 description: |- Retention in days. Remove blobs older than X days. 0 or lower means no retention. type: integer enabled: description: >- True if configuration is enabled, false if it is disabled and null if configuration is not set. type: boolean AzureResourceErrorInfo: type: object description: The azure resource error info. additionalProperties: false required: - message properties: message: type: string description: The error message. details: type: array items: $ref: '#/definitions/AzureResourceErrorInfo' x-ms-identifiers: - code description: The error details. allOf: - $ref: '#/definitions/ErrorInfo' AzureStaticWebApps: description: The configuration settings of the Azure Static Web Apps provider. type: object properties: enabled: description: >- false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. type: boolean registration: $ref: '#/definitions/AzureStaticWebAppsRegistration' description: The configuration settings of the Azure Static Web Apps registration. AzureStaticWebAppsRegistration: description: >- The configuration settings of the registration for the Azure Static Web Apps provider type: object properties: clientId: description: The Client ID of the app used for login. type: string AzureStoragePropertyDictionaryResource: description: AzureStorageInfo dictionary resource. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: Azure storage accounts. type: object additionalProperties: $ref: ./CommonDefinitions.json#/definitions/AzureStorageInfoValue x-ms-client-flatten: true AzureTableStorageApplicationLogsConfig: description: Application logs to Azure table storage configuration. required: - sasUrl type: object properties: level: description: Log level. enum: - 'Off' - Verbose - Information - Warning - Error type: string x-ms-enum: name: LogLevel modelAsString: false sasUrl: description: SAS URL to an Azure table with add/query/delete permissions. type: string BackupItem: description: Backup description. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: BackupItem resource specific properties type: object properties: id: format: int32 description: Id of the backup. type: integer readOnly: true x-ms-client-name: BackupId storageAccountUrl: description: >- SAS URL for the storage account container which contains this backup. type: string readOnly: true blobName: description: Name of the blob which contains data for this backup. type: string readOnly: true name: description: Name of this backup. type: string readOnly: true status: description: Backup status. enum: - InProgress - Failed - Succeeded - TimedOut - Created - Skipped - PartiallySucceeded - DeleteInProgress - DeleteFailed - Deleted type: string readOnly: true x-ms-enum: name: BackupItemStatus modelAsString: false sizeInBytes: format: int64 description: Size of the backup in bytes. type: integer readOnly: true created: format: date-time description: Timestamp of the backup creation. type: string readOnly: true log: description: Details regarding this backup. Might contain an error message. type: string readOnly: true databases: description: List of databases included in the backup. type: array items: $ref: '#/definitions/DatabaseBackupSetting' readOnly: true x-ms-identifiers: - name scheduled: description: >- True if this backup has been created due to a schedule being triggered. type: boolean readOnly: true lastRestoreTimeStamp: format: date-time description: Timestamp of a last restore operation which used this backup. type: string readOnly: true finishedTimeStamp: format: date-time description: Timestamp when this backup finished. type: string readOnly: true correlationId: description: >- Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. type: string readOnly: true websiteSizeInBytes: format: int64 description: Size of the original web app which has been backed up. type: integer readOnly: true x-ms-client-flatten: true BackupItemCollection: description: Collection of backup items. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/BackupItem' nextLink: description: Link to next page of resources. type: string readOnly: true BackupRequest: description: Description of a backup which will be performed. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: BackupRequest resource specific properties required: - storageAccountUrl type: object properties: backupName: description: Name of the backup. type: string enabled: description: >- True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. type: boolean storageAccountUrl: description: SAS URL to the container. type: string backupSchedule: $ref: '#/definitions/BackupSchedule' description: Schedule for the backup if it is executed periodically. databases: description: Databases included in the backup. type: array items: $ref: '#/definitions/DatabaseBackupSetting' x-ms-identifiers: - name x-ms-client-flatten: true BackupSchedule: description: >- Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. required: - frequencyInterval - frequencyUnit - keepAtLeastOneBackup - retentionPeriodInDays type: object properties: frequencyInterval: format: int32 description: >- How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) default: 7 type: integer frequencyUnit: description: >- The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) default: Day enum: - Day - Hour type: string x-ms-enum: name: FrequencyUnit modelAsString: false keepAtLeastOneBackup: description: >- True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. default: true type: boolean retentionPeriodInDays: format: int32 description: After how many days backups should be deleted. default: 30 type: integer startTime: format: date-time description: When the schedule should start working. type: string lastExecutionTime: format: date-time description: Last time when this schedule was triggered. type: string readOnly: true BlobStorageTokenStore: description: >- The configuration settings of the storage of the tokens if blob storage is used. type: object properties: sasUrlSettingName: description: >- The name of the app setting containing the SAS URL of the blob storage containing the tokens. type: string ClientRegistration: description: >- The configuration settings of the app registration for providers that have client ids and client secrets type: object properties: clientId: description: The Client ID of the app used for login. type: string clientSecretSettingName: description: The app setting name that contains the client secret. type: string ConnStringValueTypePair: description: Database connection string value to type pair. required: - value - type type: object properties: value: description: Value of pair. type: string type: description: Type of database. enum: - MySql - SQLServer - SQLAzure - Custom - NotificationHub - ServiceBus - EventHub - ApiHub - DocDb - RedisCache - PostgreSQL type: string x-ms-enum: name: ConnectionStringType modelAsString: false ConnectionStringDictionary: description: String dictionary resource. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: Connection strings. type: object additionalProperties: $ref: '#/definitions/ConnStringValueTypePair' x-ms-client-flatten: true ContainerCpuStatistics: type: object properties: cpuUsage: $ref: '#/definitions/ContainerCpuUsage' systemCpuUsage: format: int64 type: integer onlineCpuCount: format: int32 type: integer throttlingData: $ref: '#/definitions/ContainerThrottlingData' ContainerCpuUsage: type: object properties: totalUsage: format: int64 type: integer perCpuUsage: type: array items: format: int64 type: integer kernelModeUsage: format: int64 type: integer userModeUsage: format: int64 type: integer ContainerInfo: type: object properties: currentTimeStamp: format: date-time type: string previousTimeStamp: format: date-time type: string currentCpuStats: $ref: '#/definitions/ContainerCpuStatistics' previousCpuStats: $ref: '#/definitions/ContainerCpuStatistics' memoryStats: $ref: '#/definitions/ContainerMemoryStatistics' name: type: string id: type: string eth0: $ref: '#/definitions/ContainerNetworkInterfaceStatistics' ContainerMemoryStatistics: type: object properties: usage: format: int64 type: integer maxUsage: format: int64 type: integer limit: format: int64 type: integer ContainerNetworkInterfaceStatistics: type: object properties: rxBytes: format: int64 type: integer rxPackets: format: int64 type: integer rxErrors: format: int64 type: integer rxDropped: format: int64 type: integer txBytes: format: int64 type: integer txPackets: format: int64 type: integer txErrors: format: int64 type: integer txDropped: format: int64 type: integer ContainerThrottlingData: type: object properties: periods: format: int32 type: integer throttledPeriods: format: int32 type: integer throttledTime: format: int32 type: integer ContentLink: type: object properties: uri: type: string description: The content link URI. contentVersion: type: string description: The content version. readOnly: true contentSize: type: integer format: int64 description: The content size. readOnly: true contentHash: $ref: '#/definitions/ContentHash' description: The content hash. readOnly: true metadata: $ref: '#/definitions/Object' description: The metadata. readOnly: true description: The content link. ContentHash: type: object properties: algorithm: type: string description: The algorithm of the content hash. value: type: string description: The value of the content hash. description: The content hash. ContinuousWebJob: description: Continuous Web Job Information. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: ContinuousWebJob resource specific properties type: object properties: status: description: Job status. enum: - Initializing - Starting - Running - PendingRestart - Stopped type: string x-ms-enum: name: ContinuousWebJobStatus modelAsString: false detailed_status: description: Detailed status. type: string log_url: description: Log URL. type: string run_command: description: Run command. type: string url: description: Job URL. type: string extra_info_url: description: Extra Info URL. type: string web_job_type: description: Job type. enum: - Continuous - Triggered type: string x-ms-enum: name: WebJobType modelAsString: false error: description: Error information. type: string using_sdk: description: Using SDK? type: boolean settings: description: Job settings. type: object additionalProperties: type: object x-ms-client-flatten: true ContinuousWebJobCollection: description: Collection of Kudu continuous web job information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/ContinuousWebJob' nextLink: description: Link to next page of resources. type: string readOnly: true CookieExpiration: description: The configuration settings of the session cookie's expiration. type: object properties: convention: description: The convention used when determining the session cookie's expiration. enum: - FixedTime - IdentityProviderDerived type: string x-ms-enum: name: CookieExpirationConvention modelAsString: false timeToExpiration: description: >- The time after the request is made when the session cookie should expire. type: string Correlation: type: object properties: clientTrackingId: type: string description: The client tracking id. description: The correlation property. CsmDeploymentStatus: description: Deployment status response payload. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: CsmDeploymentStatus resource specific properties type: object properties: deploymentId: description: Deployment operation id. type: string status: description: Deployment build status. enum: - TimedOut - RuntimeFailed - BuildAborted - BuildFailed - BuildRequestReceived - BuildPending - BuildInProgress - BuildSuccessful - PostBuildRestartRequired - StartPolling - StartPollingWithRestart - RuntimeStarting - RuntimeSuccessful type: string x-ms-enum: name: DeploymentBuildStatus modelAsString: true numberOfInstancesInProgress: format: int32 description: Number of site instances currently being provisioned. type: integer numberOfInstancesSuccessful: format: int32 description: Number of site instances provisioned successfully. type: integer numberOfInstancesFailed: format: int32 description: Number of site instances failed to provision. type: integer failedInstancesLogs: description: >- List of URLs pointing to logs for instances which failed to provision. type: array items: type: string errors: description: List of errors. type: array items: $ref: ./CommonDefinitions.json#/definitions/ErrorEntity x-ms-identifiers: [] x-ms-client-flatten: true CsmDeploymentStatusCollection: description: Deployment status collection ARM resource. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/CsmDeploymentStatus' nextLink: description: Link to next page of resources. type: string readOnly: true CsmPublishingCredentialsPoliciesEntity: description: Publishing Credentials Policies parameters. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: CsmPublishingCredentialsPoliciesEntity resource specific properties required: - allow type: object properties: allow: description: >- true to allow access to a publishing method; otherwise, false. type: boolean x-ms-client-flatten: true CsmPublishingProfileOptions: description: Publishing options for requested profile. type: object properties: format: description: |- Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp enum: - FileZilla3 - WebDeploy - Ftp type: string x-ms-enum: name: PublishingProfileFormat modelAsString: true includeDisasterRecoveryEndpoints: description: Include the DisasterRecover endpoint if true type: boolean CsmSlotEntity: description: Deployment slot parameters. required: - targetSlot - preserveVnet type: object properties: targetSlot: description: Destination deployment slot during swap operation. type: string preserveVnet: description: >- true to preserve Virtual Network to the slot during swap; otherwise, false. type: boolean CustomHostnameAnalysisResult: description: Custom domain analysis. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: CustomHostnameAnalysisResult resource specific properties type: object properties: isHostnameAlreadyVerified: description: >- true if hostname is already verified; otherwise, false. type: boolean readOnly: true customDomainVerificationTest: description: DNS verification test result. enum: - Passed - Failed - Skipped type: string readOnly: true x-ms-enum: name: DnsVerificationTestResult modelAsString: false customDomainVerificationFailureInfo: $ref: ./CommonDefinitions.json#/definitions/ErrorEntity description: Raw failure information if DNS verification fails. readOnly: true hasConflictOnScaleUnit: description: >- true if there is a conflict on a scale unit; otherwise, false. type: boolean readOnly: true hasConflictAcrossSubscription: description: >- true if there is a conflict across subscriptions; otherwise, false. type: boolean readOnly: true conflictingAppResourceId: description: >- Name of the conflicting app on scale unit if it's within the same subscription. type: string readOnly: true cNameRecords: description: CName records controller can see for this hostname. type: array items: type: string txtRecords: description: TXT records controller can see for this hostname. type: array items: type: string aRecords: description: A records controller can see for this hostname. type: array items: type: string alternateCNameRecords: description: Alternate CName records controller can see for this hostname. type: array items: type: string alternateTxtRecords: description: Alternate TXT records controller can see for this hostname. type: array items: type: string x-ms-client-flatten: true CustomOpenIdConnectProvider: description: The configuration settings of the custom Open ID Connect provider. type: object properties: enabled: description: >- false if the custom Open ID provider provider should not be enabled; otherwise, true. type: boolean registration: $ref: '#/definitions/OpenIdConnectRegistration' description: >- The configuration settings of the app registration for the custom Open ID Connect provider. login: $ref: '#/definitions/OpenIdConnectLogin' description: >- The configuration settings of the login flow of the custom Open ID Connect provider. DatabaseBackupSetting: description: Database backup settings. required: - databaseType type: object properties: databaseType: description: Database type (e.g. SqlAzure / MySql). enum: - SqlAzure - MySql - LocalMySql - PostgreSql type: string x-ms-enum: name: DatabaseType modelAsString: true name: type: string connectionStringName: description: >- Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options. type: string connectionString: description: >- Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. type: string DayOfWeek: type: string description: The day of the week. enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday x-ms-enum: name: DayOfWeek modelAsString: false DefaultAuthorizationPolicy: description: >- The configuration settings of the Azure Active Directory default authorization policy. type: object properties: allowedPrincipals: $ref: '#/definitions/AllowedPrincipals' description: >- The configuration settings of the Azure Active Directory allowed principals. allowedApplications: description: >- The configuration settings of the Azure Active Directory allowed applications. type: array items: type: string DeletedAppRestoreRequest: description: Details about restoring a deleted app. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: DeletedAppRestoreRequest resource specific properties type: object properties: deletedSiteId: description: >- ARM resource ID of the deleted app. Example: /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId} type: string recoverConfiguration: description: >- If true, deleted site configuration, in addition to content, will be restored. type: boolean snapshotTime: description: >- Point in time to restore the deleted app from, formatted as a DateTime string. If unspecified, default value is the time that the app was deleted. type: string useDRSecondary: description: If true, the snapshot is retrieved from DRSecondary endpoint. type: boolean x-ms-client-flatten: true Deployment: description: User credentials used for publishing activity. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: Deployment resource specific properties type: object properties: status: format: int32 description: Deployment status. type: integer message: description: Details about deployment status. type: string author: description: Who authored the deployment. type: string deployer: description: Who performed the deployment. type: string author_email: description: Author email. type: string start_time: format: date-time description: Start time. type: string end_time: format: date-time description: End time. type: string active: description: >- True if deployment is currently active, false if completed and null if not started. type: boolean details: description: Details on deployment. type: string x-ms-client-flatten: true DeploymentCollection: description: Collection of app deployments. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/Deployment' nextLink: description: Link to next page of resources. type: string readOnly: true EnabledConfig: description: Enabled configuration. type: object properties: enabled: description: >- True if configuration is enabled, false if it is disabled and null if configuration is not set. type: boolean ErrorInfo: type: object description: The error info. additionalProperties: false required: - code properties: code: type: string description: The error code. ErrorResponse: description: >- Error response indicates Logic service is not able to process the incoming request. The error property contains the error details. type: object properties: error: $ref: '#/definitions/ErrorProperties' description: The error properties. ErrorProperties: description: >- Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message. type: object properties: code: description: Error code. type: string message: description: Error message indicating why the operation failed. type: string ExpressionTraces: description: The expression traces. type: object properties: value: {} inputs: type: array items: $ref: '#/definitions/ExpressionRoot' x-ms-identifiers: - path nextLink: description: The link used to get the next page of recommendations. type: string ExpressionRoot: description: The expression root. type: object properties: path: type: string description: The path. allOf: - $ref: '#/definitions/Expression' Expression: description: The expression. type: object additionalProperties: false properties: text: description: The text. type: string value: {} subexpressions: type: array description: The sub expressions. items: $ref: '#/definitions/Expression' x-ms-identifiers: [] error: $ref: '#/definitions/AzureResourceErrorInfo' Facebook: description: The configuration settings of the Facebook provider. type: object properties: enabled: description: >- false if the Facebook provider should not be enabled despite the set registration; otherwise, true. type: boolean registration: $ref: '#/definitions/AppRegistration' description: >- The configuration settings of the app registration for the Facebook provider. graphApiVersion: description: The version of the Facebook api to be used while logging in. type: string login: $ref: '#/definitions/LoginScopes' description: The configuration settings of the login flow. FileSystemApplicationLogsConfig: description: Application logs to file system configuration. type: object properties: level: description: Log level. default: 'Off' enum: - 'Off' - Verbose - Information - Warning - Error type: string x-ms-enum: name: LogLevel modelAsString: false FileSystemHttpLogsConfig: description: Http logs to file system configuration. type: object properties: retentionInMb: format: int32 description: |- Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100. maximum: 100 minimum: 25 type: integer retentionInDays: format: int32 description: |- Retention in days. Remove files older than X days. 0 or lower means no retention. type: integer enabled: description: >- True if configuration is enabled, false if it is disabled and null if configuration is not set. type: boolean FileSystemTokenStore: description: >- The configuration settings of the storage of the tokens if a file system is used. type: object properties: directory: description: The directory in which the tokens will be stored. type: string FlowAccessControlConfiguration: type: object description: The access control configuration. properties: triggers: $ref: '#/definitions/FlowAccessControlConfigurationPolicy' description: The access control configuration for invoking workflow triggers. contents: $ref: '#/definitions/FlowAccessControlConfigurationPolicy' description: The access control configuration for accessing workflow run contents. actions: $ref: '#/definitions/FlowAccessControlConfigurationPolicy' description: The access control configuration for workflow actions. workflowManagement: $ref: '#/definitions/FlowAccessControlConfigurationPolicy' description: The access control configuration for workflow management. FlowAccessControlConfigurationPolicy: type: object description: The access control configuration policy. properties: allowedCallerIpAddresses: type: array description: The allowed caller IP address ranges. items: $ref: '#/definitions/IpAddressRange' description: The ip address range. x-ms-identifiers: [] openAuthenticationPolicies: $ref: '#/definitions/OpenAuthenticationAccessPolicies' description: The authentication policies for workflow. FlowEndpointsConfiguration: type: object description: The endpoints configuration. properties: workflow: $ref: '#/definitions/FlowEndpoints' description: The workflow endpoints. connector: $ref: '#/definitions/FlowEndpoints' description: The connector endpoints. FlowEndpoints: type: object description: The flow endpoints configuration. properties: outgoingIpAddresses: type: array description: The outgoing ip address. items: $ref: '#/definitions/IpAddress' description: The ip address. x-ms-identifiers: - address accessEndpointIpAddresses: type: array description: The access endpoint ip address. items: $ref: '#/definitions/IpAddress' description: The ip address. x-ms-identifiers: - address ForwardProxy: description: The configuration settings of a forward proxy used to make the requests. type: object properties: convention: description: The convention used to determine the url of the request made. enum: - NoProxy - Standard - Custom type: string x-ms-enum: name: ForwardProxyConvention modelAsString: false customHostHeaderName: description: The name of the header containing the host of the request. type: string customProtoHeaderName: description: The name of the header containing the scheme of the request. type: string FunctionEnvelope: description: Function information. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: FunctionEnvelope resource specific properties type: object properties: function_app_id: description: Function App ID. type: string script_root_path_href: description: Script root path URI. type: string script_href: description: Script URI. type: string config_href: description: Config URI. type: string test_data_href: description: Test data URI. type: string secrets_file_href: description: Secrets file URI. type: string href: description: Function URI. type: string config: description: Config information. type: object files: description: File list. type: object additionalProperties: type: string test_data: description: Test data used when testing via the Azure Portal. type: string invoke_url_template: description: The invocation URL type: string language: description: The function language type: string isDisabled: description: Gets or sets a value indicating whether the function is disabled type: boolean x-ms-client-flatten: true FunctionEnvelopeCollection: description: Collection of Kudu function information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/FunctionEnvelope' nextLink: description: Link to next page of resources. type: string readOnly: true FunctionSecrets: description: Function secrets. type: object properties: key: description: Secret key. type: string trigger_url: description: Trigger URL. type: string GitHub: description: The configuration settings of the GitHub provider. type: object properties: enabled: description: >- false if the GitHub provider should not be enabled despite the set registration; otherwise, true. type: boolean registration: $ref: '#/definitions/ClientRegistration' description: >- The configuration settings of the app registration for the GitHub provider. login: $ref: '#/definitions/LoginScopes' description: The configuration settings of the login flow. GitHubActionCodeConfiguration: description: The GitHub action code configuration. type: object properties: runtimeStack: description: >- Runtime stack is used to determine the workflow file content for code base apps. type: string runtimeVersion: description: >- Runtime version is used to determine what build version to set in the workflow file. type: string GitHubActionConfiguration: description: The GitHub action configuration. type: object properties: codeConfiguration: $ref: '#/definitions/GitHubActionCodeConfiguration' description: GitHub Action code configuration. containerConfiguration: $ref: '#/definitions/GitHubActionContainerConfiguration' description: GitHub Action container configuration. isLinux: description: This will help determine the workflow configuration to select. type: boolean generateWorkflowFile: description: >- Workflow option to determine whether the workflow file should be generated and written to the repository. type: boolean GitHubActionContainerConfiguration: description: The GitHub action container configuration. type: object properties: serverUrl: description: >- The server URL for the container registry where the build will be hosted. type: string imageName: description: The image name for the build. type: string username: description: The username used to upload the image to the container registry. type: string password: description: The password used to upload the image to the container registry. type: string x-ms-secret: true GlobalValidation: description: >- The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. type: object properties: requireAuthentication: description: >- true if the authentication flow is required any request is made; otherwise, false. type: boolean unauthenticatedClientAction: description: >- The action to take when an unauthenticated client attempts to access the app. enum: - RedirectToLoginPage - AllowAnonymous - Return401 - Return403 type: string x-ms-enum: name: UnauthenticatedClientActionV2 modelAsString: false redirectToProvider: 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". type: string excludedPaths: description: >- The paths for which unauthenticated flow would not be redirected to the login page. type: array items: type: string Google: description: The configuration settings of the Google provider. type: object properties: enabled: description: >- false if the Google provider should not be enabled despite the set registration; otherwise, true. type: boolean registration: $ref: '#/definitions/ClientRegistration' description: >- The configuration settings of the app registration for the Google provider. login: $ref: '#/definitions/LoginScopes' description: The configuration settings of the login flow. validation: $ref: '#/definitions/AllowedAudiencesValidation' description: >- The configuration settings of the Azure Active Directory token validation flow. HostKeys: description: Functions host level keys. type: object properties: masterKey: description: Secret key. type: string functionKeys: description: Host level function keys. type: object additionalProperties: type: string systemKeys: description: System keys. type: object additionalProperties: type: string HostNameBinding: description: A hostname binding object. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: HostNameBinding resource specific properties type: object properties: siteName: description: App Service app name. type: string x-ms-mutability: - create - read domainId: description: Fully qualified ARM domain resource URI. type: string x-ms-mutability: - create - read azureResourceName: description: Azure resource name. type: string x-ms-mutability: - create - read azureResourceType: description: Azure resource type. enum: - Website - TrafficManager type: string x-ms-enum: name: AzureResourceType modelAsString: false x-ms-mutability: - create - read customHostNameDnsRecordType: description: Custom DNS record type. enum: - CName - A type: string x-ms-enum: name: CustomHostNameDnsRecordType modelAsString: false x-ms-mutability: - create - read hostNameType: description: Hostname type. enum: - Verified - Managed type: string x-ms-enum: name: HostNameType modelAsString: false x-ms-mutability: - create - read sslState: description: SSL type enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: name: SslState modelAsString: false x-ms-mutability: - create - read thumbprint: description: SSL certificate thumbprint type: string x-ms-mutability: - create - read virtualIP: description: >- Virtual IP address assigned to the hostname if IP based SSL is enabled. type: string readOnly: true x-ms-client-flatten: true HostNameBindingCollection: description: Collection of hostname bindings. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/HostNameBinding' nextLink: description: Link to next page of resources. type: string readOnly: true HttpLogsConfig: description: Http logs configuration. type: object properties: fileSystem: $ref: '#/definitions/FileSystemHttpLogsConfig' description: Http logs to file system configuration. azureBlobStorage: $ref: '#/definitions/AzureBlobStorageHttpLogsConfig' description: Http logs to azure blob storage configuration. HttpSettings: description: >- The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. type: object properties: requireHttps: description: >- false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. type: boolean routes: $ref: '#/definitions/HttpSettingsRoutes' description: The configuration settings of the paths HTTP requests. forwardProxy: $ref: '#/definitions/ForwardProxy' description: >- The configuration settings of a forward proxy used to make the requests. HttpSettingsRoutes: description: The configuration settings of the paths HTTP requests. type: object properties: apiPrefix: description: >- The prefix that should precede all the authentication/authorization paths. type: string IdentityProviders: description: >- The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. type: object properties: azureActiveDirectory: $ref: '#/definitions/AzureActiveDirectory' description: The configuration settings of the Azure Active directory provider. facebook: $ref: '#/definitions/Facebook' description: The configuration settings of the Facebook provider. gitHub: $ref: '#/definitions/GitHub' description: The configuration settings of the GitHub provider. google: $ref: '#/definitions/Google' description: The configuration settings of the Google provider. legacyMicrosoftAccount: $ref: '#/definitions/LegacyMicrosoftAccount' description: The configuration settings of the legacy Microsoft Account provider. twitter: $ref: '#/definitions/Twitter' description: The configuration settings of the Twitter provider. apple: $ref: '#/definitions/Apple' description: The configuration settings of the Apple provider. azureStaticWebApps: $ref: '#/definitions/AzureStaticWebApps' description: The configuration settings of the Azure Static Web Apps provider. customOpenIdConnectProviders: 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. type: object additionalProperties: $ref: '#/definitions/CustomOpenIdConnectProvider' IpAddress: type: object description: The ip address. properties: address: type: string description: The address. IpAddressRange: type: object description: The ip address range. properties: addressRange: type: string description: The IP address range. JsonSchema: type: object description: The JSON schema. properties: title: type: string description: The JSON title. content: type: string description: The JSON content. JwtClaimChecks: description: >- The configuration settings of the checks that should be made while validating the JWT Claims. type: object properties: allowedGroups: description: The list of the allowed groups. type: array items: type: string allowedClientApplications: description: The list of the allowed client applications. type: array items: type: string KeyInfo: description: Function key info. type: object properties: name: description: Key name type: string value: description: Key value type: string Kind: type: string enum: - Stateful - Stateless x-ms-enum: name: Kind modelAsString: true description: The workflow kind. KeyType: type: string description: The key type. enum: - NotSpecified - Primary - Secondary x-ms-enum: name: KeyType modelAsString: true LegacyMicrosoftAccount: description: The configuration settings of the legacy Microsoft Account provider. type: object properties: enabled: description: >- false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. type: boolean registration: $ref: '#/definitions/ClientRegistration' description: >- The configuration settings of the app registration for the legacy Microsoft Account provider. login: $ref: '#/definitions/LoginScopes' description: The configuration settings of the login flow. validation: $ref: '#/definitions/AllowedAudiencesValidation' description: >- The configuration settings of the legacy Microsoft Account provider token validation flow. Login: description: >- The configuration settings of the login flow of users using App Service Authentication/Authorization. type: object properties: routes: $ref: '#/definitions/LoginRoutes' description: >- The routes that specify the endpoints used for login and logout requests. tokenStore: $ref: '#/definitions/TokenStore' description: The configuration settings of the token store. preserveUrlFragmentsForLogins: description: >- true if the fragments from the request are preserved after the login request is made; otherwise, false. type: boolean allowedExternalRedirectUrls: description: >- External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. type: array items: type: string cookieExpiration: $ref: '#/definitions/CookieExpiration' description: The configuration settings of the session cookie's expiration. nonce: $ref: '#/definitions/Nonce' description: The configuration settings of the nonce used in the login flow. LoginRoutes: description: The routes that specify the endpoints used for login and logout requests. type: object properties: logoutEndpoint: description: The endpoint at which a logout request should be made. type: string LoginScopes: description: >- The configuration settings of the login flow, including the scopes that should be requested. type: object properties: scopes: description: A list of the scopes that should be requested while authenticating. type: array items: type: string MSDeploy: description: MSDeploy ARM PUT information type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: $ref: '#/definitions/MSDeployCore' description: Core resource properties type: object properties: addOnPackages: description: >- List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule. type: array items: $ref: '#/definitions/MSDeployCore' x-ms-identifiers: - packageUri x-ms-client-flatten: true MSDeployCore: description: MSDeploy ARM PUT core information type: object properties: packageUri: description: Package URI type: string connectionString: description: SQL Connection String type: string dbType: description: Database Type type: string setParametersXmlFileUri: description: >- URI of MSDeploy Parameters file. Must not be set if SetParameters is used. type: string setParameters: description: >- MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used. type: object additionalProperties: type: string skipAppData: description: >- Controls whether the MSDeploy operation skips the App_Data directory. 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. type: boolean appOffline: description: |- Sets the AppOffline rule while the MSDeploy operation executes. Setting is false by default. type: boolean MSDeployLog: description: MSDeploy log type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: MSDeployLog resource specific properties type: object properties: entries: description: List of log entry messages type: array items: $ref: '#/definitions/MSDeployLogEntry' readOnly: true x-ms-identifiers: [] x-ms-client-flatten: true MSDeployLogEntry: description: MSDeploy log entry type: object properties: time: format: date-time description: Timestamp of log entry type: string readOnly: true type: description: Log entry type enum: - Message - Warning - Error type: string readOnly: true x-ms-enum: name: MSDeployLogEntryType modelAsString: false message: description: Log entry message type: string readOnly: true MSDeployStatus: description: MSDeploy ARM response type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: MSDeployStatus resource specific properties type: object properties: deployer: description: Username of deployer type: string readOnly: true provisioningState: description: Provisioning state enum: - accepted - running - succeeded - failed - canceled type: string readOnly: true x-ms-enum: name: MSDeployProvisioningState modelAsString: false startTime: format: date-time description: Start time of deploy operation type: string readOnly: true endTime: format: date-time description: End time of deploy operation type: string readOnly: true complete: description: Whether the deployment operation has completed type: boolean readOnly: true x-ms-client-flatten: true MigrateMySqlRequest: description: MySQL migration request. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: MigrateMySqlRequest resource specific properties required: - connectionString - migrationType type: object properties: connectionString: description: Connection string to the remote MySQL database. type: string migrationType: description: The type of migration operation to be done enum: - LocalToRemote - RemoteToLocal type: string x-ms-enum: name: MySqlMigrationType modelAsString: false x-ms-client-flatten: true MigrateMySqlStatus: description: MySQL migration status. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: MigrateMySqlStatus resource specific properties type: object properties: migrationOperationStatus: description: Status of the migration task. enum: - InProgress - Failed - Succeeded - TimedOut - Created type: string readOnly: true x-ms-enum: name: OperationStatus modelAsString: false operationId: description: Operation ID for the migration task. type: string readOnly: true localMySqlEnabled: description: True if the web app has in app MySql enabled type: boolean readOnly: true x-ms-client-flatten: true NetworkFeatures: description: >- Full view of network features for an app (presently VNET integration and Hybrid Connections). type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: NetworkFeatures resource specific properties type: object properties: virtualNetworkName: description: The Virtual Network name. type: string readOnly: true virtualNetworkConnection: $ref: ./CommonDefinitions.json#/definitions/VnetInfo description: The Virtual Network summary view. readOnly: true hybridConnections: description: The Hybrid Connections summary view. type: array items: $ref: '#/definitions/RelayServiceConnectionEntity' readOnly: true hybridConnectionsV2: description: The Hybrid Connection V2 (Service Bus) view. type: array items: $ref: ./CommonDefinitions.json#/definitions/HybridConnection readOnly: true x-ms-client-flatten: true NetworkTrace: description: Network trace type: object properties: path: description: Local file path for the captured network trace file. type: string status: description: >- Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed). type: string message: description: >- Detailed message of a network trace operation, e.g. error message in case of failure. type: string Nonce: description: The configuration settings of the nonce used in the login flow. type: object properties: validateNonce: description: >- false if the nonce should not be validated while completing the login flow; otherwise, true. type: boolean nonceExpirationInterval: description: The time after the request is made when the nonce should expire. type: string Object: type: object properties: {} OpenAuthenticationAccessPolicies: type: object description: AuthenticationPolicy of type Open. properties: policies: type: object additionalProperties: $ref: '#/definitions/OpenAuthenticationAccessPolicy' description: Open authentication policies. OpenAuthenticationAccessPolicy: type: object description: Open authentication access policy defined by user. properties: type: $ref: '#/definitions/OpenAuthenticationProviderType' description: Type of provider for OAuth. claims: type: array description: The access policy claims. items: $ref: '#/definitions/OpenAuthenticationPolicyClaim' description: The access policy claim. x-ms-identifiers: - name OpenAuthenticationProviderType: type: string description: Open authentication policy provider type. enum: - AAD x-ms-enum: name: OpenAuthenticationProviderType modelAsString: true OpenAuthenticationPolicyClaim: type: object description: Open authentication policy claim. properties: name: type: string description: The name of the claim. value: type: string description: The value of the claim. OpenIdConnectClientCredential: description: >- The authentication client credentials of the custom Open ID Connect provider. type: object properties: method: description: The method that should be used to authenticate the user. enum: - ClientSecretPost type: string x-ms-enum: name: ClientCredentialMethod modelAsString: false clientSecretSettingName: description: >- The app setting that contains the client secret for the custom Open ID Connect provider. type: string OpenIdConnectConfig: description: >- The configuration settings of the endpoints used for the custom Open ID Connect provider. type: object properties: authorizationEndpoint: description: The endpoint to be used to make an authorization request. type: string tokenEndpoint: description: The endpoint to be used to request a token. type: string issuer: description: The endpoint that issues the token. type: string certificationUri: description: The endpoint that provides the keys necessary to validate the token. type: string wellKnownOpenIdConfiguration: description: >- The endpoint that contains all the configuration endpoints for the provider. type: string OpenIdConnectLogin: description: >- The configuration settings of the login flow of the custom Open ID Connect provider. type: object properties: nameClaimType: description: The name of the claim that contains the users name. type: string scopes: description: A list of the scopes that should be requested while authenticating. type: array items: type: string OpenIdConnectRegistration: description: >- The configuration settings of the app registration for the custom Open ID Connect provider. type: object properties: clientId: description: The client id of the custom Open ID Connect provider. type: string clientCredential: $ref: '#/definitions/OpenIdConnectClientCredential' description: The authentication credentials of the custom Open ID Connect provider. openIdConnectConfiguration: $ref: '#/definitions/OpenIdConnectConfig' description: >- The configuration settings of the endpoints used for the custom Open ID Connect provider. OperationResult: type: object description: The operation result definition. additionalProperties: false properties: trackingId: type: string readOnly: true description: Gets the tracking id. inputs: $ref: '#/definitions/Object' readOnly: true description: Gets the inputs. inputsLink: $ref: '#/definitions/ContentLink' readOnly: true description: Gets the link to inputs. outputs: $ref: '#/definitions/Object' readOnly: true description: Gets the outputs. outputsLink: $ref: '#/definitions/ContentLink' readOnly: true description: Gets the link to outputs. trackedProperties: $ref: '#/definitions/Object' readOnly: true description: Gets the tracked properties. retryHistory: type: array items: $ref: '#/definitions/RetryHistory' x-ms-identifiers: [] description: Gets the retry histories. iterationCount: type: integer format: int32 allOf: - $ref: '#/definitions/OperationResultProperties' OperationResultProperties: type: object x-abstract: true description: The run operation result properties. additionalProperties: false properties: startTime: type: string format: date-time description: The start time of the workflow scope repetition. endTime: type: string format: date-time description: The end time of the workflow scope repetition. correlation: $ref: '#/definitions/RunActionCorrelation' description: The correlation properties. status: $ref: '#/definitions/WorkflowStatus' description: The status of the workflow scope repetition. code: type: string description: The workflow scope repetition code. error: {} ParameterType: type: string description: The parameter type. enum: - NotSpecified - String - SecureString - Int - Float - Bool - Array - Object - SecureObject x-ms-enum: name: ParameterType modelAsString: true PerfMonCounterCollection: description: Collection of performance monitor counters. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/PerfMonResponse' x-ms-identifiers: [] nextLink: description: Link to next page of resources. type: string readOnly: true PerfMonResponse: description: Performance monitor API response. type: object properties: code: description: The response code. type: string message: description: The message. type: string data: $ref: '#/definitions/PerfMonSet' description: The performance monitor counters. PerfMonSample: description: Performance monitor sample in a set. type: object properties: time: format: date-time description: Point in time for which counter was measured. type: string instanceName: description: Name of the server on which the measurement is made. type: string value: format: double description: Value of counter at a certain time. type: number PerfMonSet: description: Metric information. type: object properties: name: description: Unique key name of the counter. type: string startTime: format: date-time description: Start time of the period. type: string endTime: format: date-time description: End time of the period. type: string timeGrain: description: Presented time grain. type: string values: description: Collection of workers that are active during this time. type: array items: $ref: '#/definitions/PerfMonSample' x-ms-identifiers: [] PremierAddOn: description: Premier add-on. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/Resource properties: properties: description: PremierAddOn resource specific properties type: object properties: sku: description: Premier add on SKU. type: string product: description: Premier add on Product. type: string vendor: description: Premier add on Vendor. type: string marketplacePublisher: description: Premier add on Marketplace publisher. type: string marketplaceOffer: description: Premier add on Marketplace offer. type: string x-ms-client-flatten: true PremierAddOnPatchResource: description: ARM resource for a PremierAddOn. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: PremierAddOnPatchResource resource specific properties type: object properties: sku: description: Premier add on SKU. type: string product: description: Premier add on Product. type: string vendor: description: Premier add on Vendor. type: string marketplacePublisher: description: Premier add on Marketplace publisher. type: string marketplaceOffer: description: Premier add on Marketplace offer. type: string x-ms-client-flatten: true PrivateAccess: description: Description of the parameters of Private Access for a Web Site. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: PrivateAccess resource specific properties type: object properties: enabled: description: Whether private access is enabled or not. type: boolean virtualNetworks: description: >- The Virtual Networks (and subnets) allowed to access the site privately. type: array items: $ref: '#/definitions/PrivateAccessVirtualNetwork' x-ms-identifiers: - key x-ms-client-flatten: true PrivateAccessSubnet: description: >- Description of a Virtual Network subnet that is useable for private site access. type: object properties: name: description: The name of the subnet. type: string key: format: int32 description: The key (ID) of the subnet. type: integer PrivateAccessVirtualNetwork: description: Description of a Virtual Network that is useable for private site access. type: object properties: name: description: The name of the Virtual Network. type: string key: format: int32 description: The key (ID) of the Virtual Network. type: integer resourceId: description: The ARM uri of the Virtual Network type: string subnets: description: >- A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network. type: array items: $ref: '#/definitions/PrivateAccessSubnet' x-ms-identifiers: - key ProcessInfo: description: Process Information. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: ProcessInfo resource specific properties type: object properties: identifier: format: int32 description: ARM Identifier for deployment. type: integer readOnly: true deployment_name: description: Deployment name. type: string href: description: HRef URI. type: string minidump: description: Minidump URI. type: string is_profile_running: description: Is profile running? type: boolean is_iis_profile_running: description: Is the IIS Profile running? type: boolean iis_profile_timeout_in_seconds: format: double description: IIS Profile timeout (seconds). type: number parent: description: Parent process. type: string children: description: Child process list. type: array items: type: string threads: description: Thread list. type: array items: $ref: '#/definitions/ProcessThreadInfo' open_file_handles: description: List of open files. type: array items: type: string modules: description: List of modules. type: array items: $ref: '#/definitions/ProcessModuleInfo' file_name: description: File name of this process. type: string command_line: description: Command line. type: string user_name: description: User name. type: string handle_count: format: int32 description: Handle count. type: integer module_count: format: int32 description: Module count. type: integer thread_count: format: int32 description: Thread count. type: integer start_time: format: date-time description: Start time. type: string total_cpu_time: description: Total CPU time. type: string user_cpu_time: description: User CPU time. type: string privileged_cpu_time: description: Privileged CPU time. type: string working_set: format: int64 description: Working set. type: integer peak_working_set: format: int64 description: Peak working set. type: integer private_memory: format: int64 description: Private memory size. type: integer virtual_memory: format: int64 description: Virtual memory size. type: integer peak_virtual_memory: format: int64 description: Peak virtual memory usage. type: integer paged_system_memory: format: int64 description: Paged system memory. type: integer non_paged_system_memory: format: int64 description: Non-paged system memory. type: integer paged_memory: format: int64 description: Paged memory. type: integer peak_paged_memory: format: int64 description: Peak paged memory. type: integer time_stamp: format: date-time description: Time stamp. type: string environment_variables: description: List of environment variables. type: object additionalProperties: type: string is_scm_site: description: Is this the SCM site? type: boolean is_webjob: description: Is this a Web Job? type: boolean description: description: Description of process. type: string x-ms-client-flatten: true ProcessInfoCollection: description: Collection of Kudu process information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/ProcessInfo' nextLink: description: Link to next page of resources. type: string readOnly: true ProcessModuleInfo: description: Process Module Information. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: ProcessModuleInfo resource specific properties type: object properties: base_address: description: Base address. Used as module identifier in ARM resource URI. type: string file_name: description: File name. type: string href: description: HRef URI. type: string file_path: description: File path. type: string module_memory_size: format: int32 description: Module memory size. type: integer file_version: description: File version. type: string file_description: description: File description. type: string product: description: Product name. type: string product_version: description: Product version. type: string is_debug: description: Is debug? type: boolean language: description: Module language (locale). type: string x-ms-client-flatten: true ProcessModuleInfoCollection: description: Collection of Kudu thread information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/ProcessModuleInfo' nextLink: description: Link to next page of resources. type: string readOnly: true ProcessThreadInfo: description: Process Thread Information. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: ProcessThreadInfo resource specific properties type: object properties: identifier: format: int32 description: Site extension ID. type: integer readOnly: true href: description: HRef URI. type: string process: description: Process URI. type: string start_address: description: Start address. type: string current_priority: format: int32 description: Current thread priority. type: integer priority_level: description: Thread priority level. type: string base_priority: format: int32 description: Base priority. type: integer start_time: format: date-time description: Start time. type: string total_processor_time: description: Total processor time. type: string user_processor_time: description: User processor time. type: string state: description: Thread state. type: string wait_reason: description: Wait reason. type: string x-ms-client-flatten: true ProcessThreadInfoCollection: description: Collection of Kudu thread information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/ProcessThreadInfo' nextLink: description: Link to next page of resources. type: string readOnly: true PublicCertificate: description: Public certificate object type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: PublicCertificate resource specific properties type: object properties: blob: format: byte description: Public Certificate byte array type: string publicCertificateLocation: description: Public Certificate Location enum: - CurrentUserMy - LocalMachineMy - Unknown type: string x-ms-enum: name: PublicCertificateLocation modelAsString: false thumbprint: description: Certificate Thumbprint type: string readOnly: true x-ms-client-flatten: true PublicCertificateCollection: description: Collection of public certificates required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/PublicCertificate' nextLink: description: Link to next page of resources. type: string readOnly: true PublishingCredentialsPoliciesCollection: description: Publishing Credentials Policies entity collection ARM resource. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/CsmPublishingCredentialsPoliciesEntity' nextLink: description: Link to next page of resources. type: string readOnly: true RecurrenceSchedule: type: object properties: minutes: type: array items: type: integer format: int32 description: The minutes. hours: type: array items: type: integer format: int32 description: The hours. weekDays: type: array items: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday x-ms-enum: name: DaysOfWeek modelAsString: false description: The days of the week. monthDays: type: array items: type: integer format: int32 description: The month days. monthlyOccurrences: type: array items: $ref: '#/definitions/RecurrenceScheduleOccurrence' x-ms-identifiers: [] description: The monthly occurrences. description: The recurrence schedule. RecurrenceScheduleOccurrence: type: object properties: day: $ref: '#/definitions/DayOfWeek' description: The day of the week. occurrence: type: integer format: int32 description: The occurrence. description: The recurrence schedule occurrence. RegenerateActionParameter: type: object properties: keyType: $ref: '#/definitions/KeyType' description: The key type. description: The access key regenerate action content. RepetitionIndex: type: object description: The workflow run action repetition index. additionalProperties: false required: - itemIndex properties: scopeName: type: string description: The scope. itemIndex: type: integer format: int32 description: The index. RelayServiceConnectionEntity: description: Hybrid Connection for an App Service app. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: RelayServiceConnectionEntity resource specific properties type: object properties: entityName: type: string entityConnectionString: type: string resourceType: type: string resourceConnectionString: type: string hostname: type: string port: format: int32 type: integer biztalkUri: type: string x-ms-client-flatten: true Response: type: object additionalProperties: false description: A response. properties: headers: $ref: '#/definitions/Object' description: A list of all the headers attached to the response. statusCode: type: integer format: int32 description: The status code of the response. bodyLink: $ref: '#/definitions/ContentLink' description: Details on the location of the body content. ResourceReference: type: object properties: id: type: string description: The resource id. name: type: string readOnly: true description: Gets the resource name. type: type: string readOnly: true description: Gets the resource type. description: The resource reference. RestoreRequest: description: Description of a restore request. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: RestoreRequest resource specific properties required: - storageAccountUrl - overwrite type: object properties: storageAccountUrl: description: SAS URL to the container. type: string blobName: description: Name of a blob which contains the backup. type: string overwrite: description: >- true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. type: boolean siteName: description: Name of an app. type: string databases: description: >- Collection of databases which should be restored. This list has to match the list of databases included in the backup. type: array items: $ref: '#/definitions/DatabaseBackupSetting' x-ms-identifiers: - name ignoreConflictingHostNames: description: >- Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. default: false type: boolean ignoreDatabases: description: Ignore the databases and only restore the site content default: false type: boolean appServicePlan: description: Specify app service plan that will own restored site. type: string operationType: description: Operation type. default: Default enum: - Default - Clone - Relocation - Snapshot - CloudFS type: string x-ms-enum: name: BackupRestoreOperationType modelAsString: false adjustConnectionStrings: description: >- true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. type: boolean hostingEnvironment: description: >- App Service Environment name, if needed (only when restoring an app to an App Service Environment). type: string x-ms-client-flatten: true Request: type: object additionalProperties: false description: A request. properties: headers: $ref: '#/definitions/Object' description: A list of all the headers attached to the request. uri: type: string description: The destination for the request. method: type: string description: The HTTP method used for the request. RequestHistoryListResult: type: object properties: value: type: array items: $ref: '#/definitions/RequestHistory' description: A list of workflow request histories. nextLink: type: string description: The URL to get the next set of results. description: The list of workflow request histories. RequestHistory: type: object additionalProperties: false description: The request history. properties: properties: $ref: '#/definitions/RequestHistoryProperties' description: The request history properties. allOf: - $ref: '#/definitions/WorkflowResource' RequestHistoryProperties: type: object additionalProperties: false description: The request history. properties: startTime: type: string format: date-time description: The time the request started. endTime: type: string format: date-time description: The time the request ended. request: $ref: '#/definitions/Request' description: The request. response: $ref: '#/definitions/Response' description: The response. RetryHistory: type: object properties: startTime: type: string format: date-time description: Gets the start time. endTime: type: string format: date-time description: Gets the end time. code: type: string description: Gets the status code. clientRequestId: type: string description: Gets the client request Id. serviceRequestId: type: string description: Gets the service request Id. error: $ref: '#/definitions/ErrorResponse' description: Gets the error response. description: The retry history. RunActionCorrelation: type: object description: The workflow run action correlation properties. additionalProperties: false properties: actionTrackingId: type: string description: The action tracking identifier. allOf: - $ref: '#/definitions/RunCorrelation' RunCorrelation: type: object description: The correlation properties. additionalProperties: false properties: clientTrackingId: type: string description: The client tracking identifier. clientKeywords: type: array description: The client keywords. items: type: string SiteAuthSettings: description: >- Configuration settings for the Azure App Service Authentication / Authorization feature. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SiteAuthSettings resource specific properties type: object properties: enabled: description: >- true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. type: boolean runtimeVersion: description: >- The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. type: string unauthenticatedClientAction: description: >- The action to take when an unauthenticated client attempts to access the app. enum: - RedirectToLoginPage - AllowAnonymous type: string x-ms-enum: name: UnauthenticatedClientAction modelAsString: false tokenStoreEnabled: description: >- true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. type: boolean allowedExternalRedirectUrls: description: >- External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. type: array items: type: string defaultProvider: description: >- The default authentication provider to use when multiple providers are configured. 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 type: string x-ms-enum: name: BuiltInAuthenticationProvider modelAsString: false tokenRefreshExtensionHours: format: double description: >- The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. type: number clientId: description: >- The Client ID of this relying party application, known as the client_id. 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 type: string clientSecret: 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 type: string clientSecretSettingName: description: >- The app setting name that contains the client secret of the relying party application. type: string clientSecretCertificateThumbprint: description: >- An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional. type: string issuer: description: >- The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. 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 type: string validateIssuer: description: >- Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. type: boolean allowedAudiences: description: >- Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting. type: array items: type: string additionalLoginParams: 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". type: array items: type: string aadClaimsAuthorization: description: Gets a JSON string containing the Azure AD Acl settings. type: string googleClientId: description: >- The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ type: string googleClientSecret: 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/ type: string googleClientSecretSettingName: description: >- The app setting name that contains the client secret associated with the Google web application. type: string googleOAuthScopes: 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/ type: array items: type: string facebookAppId: 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 type: string facebookAppSecret: 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 type: string facebookAppSecretSettingName: description: >- The app setting name that contains the app secret used for Facebook Login. type: string facebookOAuthScopes: description: >- The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login type: array items: type: string gitHubClientId: description: |- The Client Id of the GitHub app used for login. This setting is required for enabling Github login type: string gitHubClientSecret: description: |- The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login. type: string gitHubClientSecretSettingName: description: |- The app setting name that contains the client secret of the Github app used for GitHub Login. type: string gitHubOAuthScopes: description: >- The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional type: array items: type: string twitterConsumerKey: 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 type: string twitterConsumerSecret: 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 type: string twitterConsumerSecretSettingName: description: >- The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. type: string microsoftAccountClientId: 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 type: string microsoftAccountClientSecret: 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 type: string microsoftAccountClientSecretSettingName: description: >- The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. type: string microsoftAccountOAuthScopes: 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 type: array items: type: string isAuthFromFile: description: |- "true" if the auth config settings should be read from a file, "false" otherwise type: string authFilePath: description: |- The path of the config file containing auth settings. If the path is relative, base will the site's root directory. type: string configVersion: 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. type: string x-ms-client-flatten: true SiteAuthSettingsV2: description: >- Configuration settings for the Azure App Service Authentication / Authorization V2 feature. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SiteAuthSettingsV2 resource specific properties type: object properties: platform: $ref: '#/definitions/AuthPlatform' description: >- The configuration settings of the platform of App Service Authentication/Authorization. globalValidation: $ref: '#/definitions/GlobalValidation' description: >- The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. identityProviders: $ref: '#/definitions/IdentityProviders' description: >- The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. login: $ref: '#/definitions/Login' description: >- The configuration settings of the login flow of users using App Service Authentication/Authorization. httpSettings: $ref: '#/definitions/HttpSettings' description: >- The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. x-ms-client-flatten: true SiteCloneability: description: Represents whether or not an app is cloneable. type: object properties: result: description: Name of app. enum: - Cloneable - PartiallyCloneable - NotCloneable type: string x-ms-enum: name: CloneAbilityResult modelAsString: false blockingFeatures: description: List of features enabled on app that prevent cloning. type: array items: $ref: '#/definitions/SiteCloneabilityCriterion' x-ms-identifiers: - name unsupportedFeatures: 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. type: array items: $ref: '#/definitions/SiteCloneabilityCriterion' x-ms-identifiers: - name blockingCharacteristics: description: List of blocking application characteristics. type: array items: $ref: '#/definitions/SiteCloneabilityCriterion' x-ms-identifiers: - name SiteCloneabilityCriterion: description: An app cloneability criterion. type: object properties: name: description: Name of criterion. type: string description: description: Description of criterion. type: string SiteConfigResource: description: Web app configuration ARM resource. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: $ref: ./CommonDefinitions.json#/definitions/SiteConfig description: Core resource properties type: object x-ms-client-flatten: true SiteConfigResourceCollection: description: Collection of site configurations. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/SiteConfigResource' nextLink: description: Link to next page of resources. type: string readOnly: true SiteConfigurationSnapshotInfo: description: A snapshot of a web app configuration. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SiteConfigurationSnapshotInfo resource specific properties type: object properties: time: format: date-time description: The time the snapshot was taken. type: string readOnly: true snapshotId: format: int32 description: The id of the snapshot type: integer readOnly: true x-ms-client-flatten: true SiteConfigurationSnapshotInfoCollection: description: >- Collection of metadata for the app configuration snapshots that can be restored. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/SiteConfigurationSnapshotInfo' nextLink: description: Link to next page of resources. type: string readOnly: true SiteExtensionInfo: description: Site Extension Information. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SiteExtensionInfo resource specific properties type: object properties: extension_id: description: Site extension ID. type: string title: type: string extension_type: description: Site extension type. enum: - Gallery - WebRoot type: string x-ms-enum: name: SiteExtensionType modelAsString: false summary: description: Summary description. type: string description: description: Detailed description. type: string version: description: Version information. type: string extension_url: description: Extension URL. type: string project_url: description: Project URL. type: string icon_url: description: Icon URL. type: string license_url: description: License URL. type: string feed_url: description: Feed URL. type: string authors: description: List of authors. type: array items: type: string installer_command_line_params: description: Installer command line parameters. type: string published_date_time: format: date-time description: Published timestamp. type: string download_count: format: int32 description: Count of downloads. type: integer local_is_latest_version: description: >- true if the local version is the latest version; false otherwise. type: boolean local_path: description: Local path. type: string installed_date_time: format: date-time description: Installed timestamp. type: string provisioningState: description: Provisioning state. type: string comment: description: Site Extension comment. type: string x-ms-client-flatten: true SiteExtensionInfoCollection: description: Collection of Kudu site extension information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/SiteExtensionInfo' nextLink: description: Link to next page of resources. type: string readOnly: true SiteLogsConfig: description: Configuration of App Service site logs. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SiteLogsConfig resource specific properties type: object properties: applicationLogs: $ref: '#/definitions/ApplicationLogsConfig' description: Application logs configuration. httpLogs: $ref: '#/definitions/HttpLogsConfig' description: HTTP logs configuration. failedRequestsTracing: $ref: '#/definitions/EnabledConfig' description: Failed requests tracing configuration. detailedErrorMessages: $ref: '#/definitions/EnabledConfig' description: Detailed error messages configuration. x-ms-client-flatten: true SitePatchResource: description: ARM resource for a site. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SitePatchResource resource specific properties type: object properties: state: description: Current state of the app. type: string readOnly: true hostNames: description: Hostnames associated with the app. type: array items: type: string readOnly: true repositorySiteName: description: Name of the repository site. type: string readOnly: true usageState: description: >- State indicating whether the app has exceeded its quota usage. Read-only. enum: - Normal - Exceeded type: string readOnly: true x-ms-enum: name: UsageState modelAsString: false enabled: description: >- true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). type: boolean enabledHostNames: description: >- Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. type: array items: type: string readOnly: true availabilityState: description: Management information availability state for the app. enum: - Normal - Limited - DisasterRecoveryMode type: string readOnly: true x-ms-enum: name: SiteAvailabilityState modelAsString: false hostNameSslStates: description: >- Hostname SSL states are used to manage the SSL bindings for app's hostnames. type: array items: $ref: ./CommonDefinitions.json#/definitions/HostNameSslState x-ms-identifiers: - name serverFarmId: description: >- Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". type: string reserved: description: true if reserved; otherwise, false. default: false type: boolean x-ms-mutability: - create - read isXenon: description: 'Obsolete: Hyper-V sandbox.' default: false type: boolean x-ms-mutability: - create - read hyperV: description: Hyper-V sandbox. default: false type: boolean x-ms-mutability: - create - read lastModifiedTimeUtc: format: date-time description: Last time the app was modified, in UTC. Read-only. type: string readOnly: true siteConfig: $ref: ./CommonDefinitions.json#/definitions/SiteConfig description: Configuration of the app. trafficManagerHostNames: description: >- Azure Traffic Manager hostnames associated with the app. Read-only. type: array items: type: string readOnly: true scmSiteAlsoStopped: description: >- true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. default: false type: boolean targetSwapSlot: description: >- Specifies which deployment slot this app will swap into. Read-only. type: string readOnly: true hostingEnvironmentProfile: $ref: ./CommonDefinitions.json#/definitions/HostingEnvironmentProfile description: App Service Environment to use for the app. x-ms-mutability: - create - read clientAffinityEnabled: description: >- true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true. type: boolean clientCertEnabled: description: >- true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. type: boolean clientCertMode: description: >- This composes with ClientCertEnabled setting. - 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 type: string x-ms-enum: name: ClientCertMode modelAsString: false clientCertExclusionPaths: description: client certificate authentication comma-separated exclusion paths type: string hostNamesDisabled: description: >- true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. type: boolean customDomainVerificationId: description: >- Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. type: string outboundIpAddresses: description: >- List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. type: string readOnly: true possibleOutboundIpAddresses: description: >- List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. type: string readOnly: true containerSize: format: int32 description: Size of the function container. type: integer dailyMemoryTimeQuota: format: int32 description: >- Maximum allowed daily memory-time quota (applicable on dynamic apps only). type: integer suspendedTill: format: date-time description: App suspended till in case memory-time quota is exceeded. type: string readOnly: true maxNumberOfWorkers: format: int32 description: |- Maximum number of workers. This only applies to Functions container. type: integer readOnly: true cloningInfo: $ref: ./CommonDefinitions.json#/definitions/CloningInfo description: >- If specified during app creation, the app is cloned from a source app. x-ms-mutability: - create resourceGroup: description: Name of the resource group the app belongs to. Read-only. type: string readOnly: true isDefaultContainer: description: >- true if the app is a default container; otherwise, false. type: boolean readOnly: true defaultHostName: description: Default hostname of the app. Read-only. type: string readOnly: true slotSwapStatus: $ref: ./CommonDefinitions.json#/definitions/SlotSwapStatus description: Status of the last deployment slot swap operation. readOnly: true httpsOnly: description: >- HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests type: boolean redundancyMode: description: Site redundancy mode enum: - None - Manual - Failover - ActiveActive - GeoRedundant type: string x-ms-enum: name: RedundancyMode modelAsString: false inProgressOperationId: format: uuid description: Specifies an operation id if this site has a pending operation. type: string readOnly: true example: 00000000-0000-0000-0000-000000000000 storageAccountRequired: description: Checks if Customer provided storage account is required type: boolean keyVaultReferenceIdentity: description: Identity to use for Key Vault Reference authentication. type: string virtualNetworkSubnetId: 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} type: string x-ms-client-flatten: true identity: $ref: ./CommonDefinitions.json#/definitions/ManagedServiceIdentity SitePhpErrorLogFlag: description: Used for getting PHP error logging flag. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SitePhpErrorLogFlag resource specific properties type: object properties: localLogErrors: description: Local log_errors setting. type: string masterLogErrors: description: Master log_errors setting. type: string localLogErrorsMaxLength: description: Local log_errors_max_len setting. type: string masterLogErrorsMaxLength: description: Master log_errors_max_len setting. type: string x-ms-client-flatten: true SiteSourceControl: description: Source control configuration for an app. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SiteSourceControl resource specific properties type: object properties: repoUrl: description: Repository or source control URL. type: string x-ms-mutability: - create - read branch: description: Name of branch to use for deployment. type: string x-ms-mutability: - create - read isManualIntegration: description: >- true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub). type: boolean x-ms-mutability: - create - read isGitHubAction: description: true if this is deployed via GitHub action. type: boolean x-ms-mutability: - create - read deploymentRollbackEnabled: description: >- true to enable deployment rollback; otherwise, false. type: boolean x-ms-mutability: - create - read isMercurial: description: >- true for a Mercurial repository; false for a Git repository. type: boolean x-ms-mutability: - create - read gitHubActionConfiguration: $ref: '#/definitions/GitHubActionConfiguration' description: If GitHub Action is selected, than the associated configuration. x-ms-client-flatten: true SlotConfigNames: 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. type: object properties: connectionStringNames: description: List of connection string names. type: array items: type: string appSettingNames: description: List of application settings names. type: array items: type: string azureStorageConfigNames: description: List of external Azure storage account identifiers. type: array items: type: string SlotConfigNamesResource: description: Slot Config names azure resource. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: $ref: '#/definitions/SlotConfigNames' description: Core resource properties type: object x-ms-client-flatten: true SlotDifference: description: A setting difference between two deployment slots of an app. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SlotDifference resource specific properties type: object properties: level: description: 'Level of the difference: Information, Warning or Error.' type: string readOnly: true settingType: description: 'The type of the setting: General, AppSetting or ConnectionString.' type: string readOnly: true diffRule: description: >- Rule that describes how to process the setting difference during a slot swap. type: string readOnly: true settingName: description: Name of the setting. type: string readOnly: true valueInCurrentSlot: description: Value of the setting in the current slot. type: string readOnly: true valueInTargetSlot: description: Value of the setting in the target slot. type: string readOnly: true description: description: Description of the setting difference. type: string readOnly: true x-ms-client-flatten: true SlotDifferenceCollection: description: Collection of slot differences. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/SlotDifference' nextLink: description: Link to next page of resources. type: string readOnly: true SnapshotCollection: description: >- Collection of snapshots which can be used to revert an app to a previous time. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: ./CommonDefinitions.json#/definitions/Snapshot nextLink: description: Link to next page of resources. type: string readOnly: true SnapshotRecoverySource: description: Specifies the web app that snapshot contents will be retrieved from. type: object properties: location: description: >- Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS type: string id: description: >- ARM resource ID of the source app. /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. type: string SnapshotRestoreRequest: description: Details about app recovery operation. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SnapshotRestoreRequest resource specific properties required: - overwrite type: object properties: snapshotTime: description: >- Point in time in which the app restore should be done, formatted as a DateTime string. type: string recoverySource: $ref: '#/definitions/SnapshotRecoverySource' description: >- Optional. Specifies the web app that snapshot contents will be retrieved from. If empty, the targeted web app will be used as the source. overwrite: description: >- If true the restore operation can overwrite source app; otherwise, false. type: boolean recoverConfiguration: description: >- If true, site configuration, in addition to content, will be reverted. type: boolean ignoreConflictingHostNames: description: >- If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled. type: boolean useDRSecondary: description: If true, the snapshot is retrieved from DRSecondary endpoint. type: boolean x-ms-client-flatten: true StorageMigrationOptions: description: Options for app content migration. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: StorageMigrationOptions resource specific properties required: - azurefilesConnectionString - azurefilesShare type: object properties: azurefilesConnectionString: description: AzureFiles connection string. type: string x-ms-mutability: - create azurefilesShare: description: AzureFiles share. type: string x-ms-mutability: - create switchSiteAfterMigration: description: >- trueif the app should be switched over; otherwise, false. default: false type: boolean x-ms-mutability: - create blockWriteAccessToSite: description: >- true if the app should be read only during copy operation; otherwise, false. default: false type: boolean x-ms-mutability: - create x-ms-client-flatten: true StorageMigrationResponse: description: Response for a migration of app content request. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: StorageMigrationResponse resource specific properties type: object properties: operationId: description: >- When server starts the migration process, it will return an operation ID identifying that particular migration operation. type: string readOnly: true x-ms-client-flatten: true SubResource: type: object properties: id: type: string readOnly: true description: The resource id. x-ms-azure-resource: true description: The sub resource type. SwiftVirtualNetwork: description: >- Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SwiftVirtualNetwork resource specific properties type: object properties: subnetResourceId: description: >- The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first. type: string swiftSupported: description: >- A flag that specifies if the scale unit this Web App is on supports Swift integration. type: boolean x-ms-client-flatten: true TokenStore: description: The configuration settings of the token store. type: object properties: enabled: description: >- true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false. type: boolean tokenRefreshExtensionHours: 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. type: number fileSystem: $ref: '#/definitions/FileSystemTokenStore' description: >- The configuration settings of the storage of the tokens if a file system is used. azureBlobStorage: $ref: '#/definitions/BlobStorageTokenStore' description: >- The configuration settings of the storage of the tokens if blob storage is used. TriggeredJobHistory: description: >- Triggered Web Job History. List of Triggered Web Job Run Information elements. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: TriggeredJobHistory resource specific properties type: object properties: runs: description: List of triggered web job runs. type: array items: $ref: '#/definitions/TriggeredJobRun' x-ms-identifiers: - web_job_id x-ms-client-flatten: true TriggeredJobHistoryCollection: description: Collection of Kudu continuous web job information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/TriggeredJobHistory' nextLink: description: Link to next page of resources. type: string readOnly: true TriggeredJobRun: description: Triggered Web Job Run Information. type: object properties: web_job_id: description: Job ID. type: string web_job_name: description: Job name. type: string status: description: Job status. enum: - Success - Failed - Error type: string x-ms-enum: name: TriggeredWebJobStatus modelAsString: false start_time: format: date-time description: Start time. type: string end_time: format: date-time description: End time. type: string duration: description: Job duration. type: string output_url: description: Output URL. type: string error_url: description: Error URL. type: string url: description: Job URL. type: string job_name: description: Job name. type: string trigger: description: Job trigger. type: string TriggeredWebJob: description: Triggered Web Job Information. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: TriggeredWebJob resource specific properties type: object properties: latest_run: $ref: '#/definitions/TriggeredJobRun' description: Latest job run information. history_url: description: History URL. type: string scheduler_logs_url: description: Scheduler Logs URL. type: string run_command: description: Run command. type: string url: description: Job URL. type: string extra_info_url: description: Extra Info URL. type: string web_job_type: description: Job type. enum: - Continuous - Triggered type: string x-ms-enum: name: WebJobType modelAsString: false error: description: Error information. type: string using_sdk: description: Using SDK? type: boolean publicNetworkAccess: description: >- Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. type: string storageAccountRequired: description: Checks if Customer provided storage account is required type: boolean settings: description: Job settings. type: object additionalProperties: type: object x-ms-client-flatten: true TriggeredWebJobCollection: description: Collection of Kudu continuous web job information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/TriggeredWebJob' nextLink: description: Link to next page of resources. type: string readOnly: true Twitter: description: The configuration settings of the Twitter provider. type: object properties: enabled: description: >- false if the Twitter provider should not be enabled despite the set registration; otherwise, true. type: boolean registration: $ref: '#/definitions/TwitterRegistration' description: >- The configuration settings of the app registration for the Twitter provider. TwitterRegistration: description: >- The configuration settings of the app registration for the Twitter provider. type: object properties: consumerKey: 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 type: string consumerSecretSettingName: description: >- The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. type: string WebAppInstanceStatusCollection: description: Collection of app instances. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/WebSiteInstanceStatus' nextLink: description: Link to next page of resources. type: string readOnly: true WebJob: description: Web Job Information. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: WebJob resource specific properties type: object properties: run_command: description: Run command. type: string url: description: Job URL. type: string extra_info_url: description: Extra Info URL. type: string web_job_type: description: Job type. enum: - Continuous - Triggered type: string x-ms-enum: name: WebJobType modelAsString: false error: description: Error information. type: string using_sdk: description: Using SDK? type: boolean settings: description: Job settings. type: object additionalProperties: type: object x-ms-client-flatten: true WebJobCollection: description: Collection of Kudu web job information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/WebJob' nextLink: description: Link to next page of resources. type: string readOnly: true WebSiteInstanceStatus: type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: WebSiteInstanceStatus resource specific properties type: object properties: state: enum: - READY - STOPPED - UNKNOWN type: string x-ms-enum: name: SiteRuntimeState modelAsString: false statusUrl: description: Link to the GetStatusApi in Kudu type: string detectorUrl: description: Link to the Diagnose and Solve Portal type: string consoleUrl: description: Link to the console to web app instance type: string healthCheckUrl: description: Link to the console to web app instance type: string containers: type: object additionalProperties: $ref: '#/definitions/ContainerInfo' x-ms-client-flatten: true Workflow: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkflowProperties' description: The workflow properties. identity: $ref: ./CommonDefinitions.json#/definitions/ManagedServiceIdentity description: The workflow type. allOf: - $ref: '#/definitions/WorkflowResource' WorkflowArtifacts: type: object properties: appSettings: $ref: '#/definitions/Object' description: Application settings of the workflow. files: $ref: '#/definitions/WorkflowFiles' description: Files of the app. filesToDelete: type: array items: type: string description: Files of the app to delete. description: The workflow filter. WorkflowFilter: type: object properties: state: $ref: '#/definitions/WorkflowState' description: The state of workflows. description: The workflow filter. WorkflowParameter: type: object properties: type: $ref: '#/definitions/ParameterType' description: The type. value: $ref: '#/definitions/Object' description: The value. metadata: $ref: '#/definitions/Object' description: The metadata. description: type: string description: The description. description: The workflow parameters. WorkflowProperties: type: object properties: provisioningState: $ref: '#/definitions/WorkflowProvisioningState' readOnly: true description: Gets the provisioning state. createdTime: type: string format: date-time readOnly: true description: Gets the created time. changedTime: type: string format: date-time readOnly: true description: Gets the changed time. state: $ref: '#/definitions/WorkflowState' description: The state. version: type: string readOnly: true description: Gets the version. accessEndpoint: type: string readOnly: true description: Gets the access endpoint. endpointsConfiguration: $ref: '#/definitions/FlowEndpointsConfiguration' description: The endpoints configuration. accessControl: $ref: '#/definitions/FlowAccessControlConfiguration' description: The access control configuration. sku: $ref: '#/definitions/WorkflowSku' readOnly: true description: The sku. integrationAccount: $ref: '#/definitions/ResourceReference' description: The integration account. integrationServiceEnvironment: $ref: '#/definitions/ResourceReference' description: The integration service environment. definition: $ref: '#/definitions/Object' description: The definition. parameters: type: object additionalProperties: $ref: '#/definitions/WorkflowParameter' description: The parameters. kind: $ref: '#/definitions/Kind' description: The workflow kind. description: The workflow properties. WorkflowProvisioningState: type: string description: The workflow provisioning state. enum: - NotSpecified - Accepted - Running - Ready - Creating - Created - Deleting - Deleted - Canceled - Failed - Succeeded - Moving - Updating - Registering - Registered - Unregistering - Unregistered - Completed - Renewing - Pending - Waiting - InProgress x-ms-enum: name: WorkflowProvisioningState modelAsString: true WorkflowListResult: type: object properties: value: type: array items: $ref: '#/definitions/Workflow' description: The list of workflows. nextLink: type: string description: The URL to get the next set of results. description: The list of workflows. WorkflowOutputParameter: type: object properties: error: $ref: '#/definitions/Object' readOnly: true description: Gets the error. description: The workflow output parameter. allOf: - $ref: '#/definitions/WorkflowParameter' RecurrenceFrequency: type: string description: The recurrence frequency. enum: - NotSpecified - Second - Minute - Hour - Day - Week - Month - Year x-ms-enum: name: RecurrenceFrequency modelAsString: true WorkflowEnvelope: description: Workflow properties definition. type: object properties: id: type: string readOnly: true description: The resource id. name: type: string readOnly: true description: Gets the resource name. type: type: string readOnly: true description: Gets the resource type. kind: type: string description: The resource kind. location: type: string description: The resource location. x-ms-mutability: - create - read properties: description: Additional workflow properties. type: object properties: files: description: Gets or sets the files. $ref: '#/definitions/WorkflowFiles' flowState: description: Gets or sets the state of the workflow. $ref: '#/definitions/WorkflowState' health: $ref: '#/definitions/WorkflowHealth' description: Gets or sets workflow health. WorkflowEnvelopeCollection: description: Collection of Kudu workflow information elements. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/WorkflowEnvelope' nextLink: description: Link to next page of resources. type: string readOnly: true WorkflowFiles: description: Gets or sets the files. type: object additionalProperties: type: object WorkflowHealth: description: Represents the workflow health. required: - state type: object properties: state: description: Gets or sets the workflow health state. enum: - NotSpecified - Healthy - Unhealthy - Unknown type: string x-ms-enum: name: WorkflowHealthState modelAsString: false error: $ref: ./CommonDefinitions.json#/definitions/ErrorEntity description: Gets or sets the workflow error. WorkflowResource: type: object properties: id: type: string readOnly: true description: The resource id. name: type: string readOnly: true description: Gets the resource name. type: type: string readOnly: true description: Gets the resource type. location: type: string description: The resource location. tags: type: object additionalProperties: type: string description: The resource tags. x-ms-azure-resource: true description: The base resource type. WorkflowRun: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkflowRunProperties' description: The workflow run properties. name: type: string readOnly: true description: Gets the workflow run name. type: type: string readOnly: true description: Gets the workflow run type. description: The workflow run. allOf: - $ref: '#/definitions/SubResource' WorkflowRunAction: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkflowRunActionProperties' description: The workflow run action properties. name: type: string readOnly: true description: Gets the workflow run action name. type: type: string readOnly: true description: Gets the workflow run action type. description: The workflow run action. allOf: - $ref: '#/definitions/SubResource' WorkflowRunActionListResult: type: object properties: value: type: array items: $ref: '#/definitions/WorkflowRunAction' description: A list of workflow run actions. nextLink: type: string description: The URL to get the next set of results. description: The list of workflow run actions. WorkflowRunActionProperties: type: object properties: startTime: type: string format: date-time readOnly: true description: Gets the start time. endTime: type: string format: date-time readOnly: true description: Gets the end time. status: $ref: '#/definitions/WorkflowStatus' readOnly: true description: Gets the status. code: type: string readOnly: true description: Gets the code. error: $ref: '#/definitions/Object' readOnly: true description: Gets the error. trackingId: type: string readOnly: true description: Gets the tracking id. correlation: $ref: '#/definitions/RunActionCorrelation' description: The correlation properties. inputsLink: $ref: '#/definitions/ContentLink' readOnly: true description: Gets the link to inputs. outputsLink: $ref: '#/definitions/ContentLink' readOnly: true description: Gets the link to outputs. trackedProperties: $ref: '#/definitions/Object' readOnly: true description: Gets the tracked properties. retryHistory: type: array items: $ref: '#/definitions/RetryHistory' x-ms-identifiers: [] description: Gets the retry histories. description: The workflow run action properties. WorkflowRunActionRepetitionDefinitionCollection: type: object description: A collection of workflow run action repetitions. properties: nextLink: description: The link used to get the next page of recommendations. type: string value: type: array items: $ref: '#/definitions/WorkflowRunActionRepetitionDefinition' WorkflowRunActionRepetitionDefinition: type: object description: The workflow run action repetition definition. additionalProperties: false required: - properties properties: properties: $ref: '#/definitions/WorkflowRunActionRepetitionProperties' description: The workflow run action repetition properties definition. x-ms-client-flatten: true allOf: - $ref: '#/definitions/WorkflowResource' WorkflowRunActionRepetitionProperties: type: object description: The workflow run action repetition properties definition. additionalProperties: false properties: repetitionIndexes: type: array description: The repetition indexes. items: $ref: '#/definitions/RepetitionIndex' x-ms-identifiers: - itemIndex allOf: - $ref: '#/definitions/OperationResult' WorkflowRunListResult: type: object properties: value: type: array items: $ref: '#/definitions/WorkflowRun' description: A list of workflow runs. nextLink: type: string description: The URL to get the next set of results. description: The list of workflow runs. WorkflowRunProperties: type: object properties: waitEndTime: type: string format: date-time readOnly: true description: Gets the wait end time. startTime: type: string format: date-time readOnly: true description: Gets the start time. endTime: type: string format: date-time readOnly: true description: Gets the end time. status: $ref: '#/definitions/WorkflowStatus' readOnly: true description: Gets the status. code: type: string readOnly: true description: Gets the code. error: $ref: '#/definitions/Object' readOnly: true description: Gets the error. correlationId: type: string readOnly: true description: Gets the correlation id. correlation: $ref: '#/definitions/Correlation' description: The run correlation. workflow: $ref: '#/definitions/ResourceReference' readOnly: true description: Gets the reference to workflow version. trigger: $ref: '#/definitions/WorkflowRunTrigger' readOnly: true description: Gets the fired trigger. outputs: type: object readOnly: true additionalProperties: $ref: '#/definitions/WorkflowOutputParameter' description: The workflow output parameter. description: Gets the outputs. response: $ref: '#/definitions/WorkflowRunTrigger' readOnly: true description: Gets the response of the flow run. description: The workflow run properties. WorkflowRunActionFilter: type: object properties: status: $ref: '#/definitions/WorkflowStatus' description: The status of workflow run action. description: The workflow run action filter. WorkflowRunFilter: type: object properties: status: $ref: '#/definitions/WorkflowStatus' description: The status of workflow run. description: The workflow run filter. WorkflowRunTrigger: type: object properties: name: type: string readOnly: true description: Gets the name. inputs: $ref: '#/definitions/Object' readOnly: true description: Gets the inputs. inputsLink: $ref: '#/definitions/ContentLink' readOnly: true description: Gets the link to inputs. outputs: $ref: '#/definitions/Object' readOnly: true description: Gets the outputs. outputsLink: $ref: '#/definitions/ContentLink' readOnly: true description: Gets the link to outputs. scheduledTime: type: string format: date-time readOnly: true description: Gets the scheduled time. startTime: type: string format: date-time readOnly: true description: Gets the start time. endTime: type: string format: date-time readOnly: true description: Gets the end time. trackingId: type: string readOnly: true description: Gets the tracking id. correlation: $ref: '#/definitions/Correlation' description: The run correlation. code: type: string readOnly: true description: Gets the code. status: $ref: '#/definitions/WorkflowStatus' readOnly: true description: Gets the status. error: $ref: '#/definitions/Object' readOnly: true description: Gets the error. trackedProperties: $ref: '#/definitions/Object' readOnly: true description: Gets the tracked properties. description: The workflow run trigger. WorkflowSku: type: object description: The sku type. required: - name properties: name: $ref: '#/definitions/WorkflowSkuName' description: The name. plan: $ref: '#/definitions/ResourceReference' description: The reference to plan. WorkflowSkuName: type: string enum: - NotSpecified - Free - Shared - Basic - Standard - Premium x-ms-enum: name: WorkflowSkuName modelAsString: true description: The sku name. WorkflowState: type: string description: The workflow state. enum: - NotSpecified - Completed - Enabled - Disabled - Deleted - Suspended x-ms-enum: name: WorkflowState modelAsString: true WorkflowStatus: type: string description: The workflow status. enum: - NotSpecified - Paused - Running - Waiting - Succeeded - Skipped - Suspended - Cancelled - Failed - Faulted - TimedOut - Aborted - Ignored x-ms-enum: name: WorkflowStatus modelAsString: true WorkflowTrigger: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkflowTriggerProperties' description: The workflow trigger properties. name: type: string readOnly: true description: Gets the workflow trigger name. type: type: string readOnly: true description: Gets the workflow trigger type. description: The workflow trigger. allOf: - $ref: '#/definitions/SubResource' WorkflowTriggerCallbackUrl: type: object properties: value: type: string readOnly: true description: Gets the workflow trigger callback URL. method: type: string readOnly: true description: Gets the workflow trigger callback URL HTTP method. basePath: type: string readOnly: true description: Gets the workflow trigger callback URL base path. relativePath: type: string readOnly: true description: Gets the workflow trigger callback URL relative path. relativePathParameters: type: array items: type: string description: Gets the workflow trigger callback URL relative path parameters. queries: $ref: '#/definitions/WorkflowTriggerListCallbackUrlQueries' description: Gets the workflow trigger callback URL query parameters. description: The workflow trigger callback URL. WorkflowTriggerFilter: type: object properties: state: $ref: '#/definitions/WorkflowState' description: The state of workflow trigger. description: The workflow trigger filter. WorkflowTriggerListCallbackUrlQueries: type: object properties: api-version: type: string description: The api version. sp: type: string description: The SAS permissions. sv: type: string description: The SAS version. sig: type: string description: The SAS signature. se: type: string description: The SAS timestamp. description: Gets the workflow trigger callback URL query parameters. WorkflowTriggerHistory: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkflowTriggerHistoryProperties' description: Gets the workflow trigger history properties. name: type: string readOnly: true description: Gets the workflow trigger history name. type: type: string readOnly: true description: Gets the workflow trigger history type. description: The workflow trigger history. allOf: - $ref: '#/definitions/SubResource' WorkflowTriggerHistoryFilter: type: object properties: status: $ref: '#/definitions/WorkflowStatus' description: The status of workflow trigger history. description: The workflow trigger history filter. WorkflowTriggerHistoryProperties: type: object properties: startTime: type: string format: date-time readOnly: true description: Gets the start time. endTime: type: string format: date-time readOnly: true description: Gets the end time. scheduledTime: type: string format: date-time readOnly: true description: The scheduled time. status: $ref: '#/definitions/WorkflowStatus' readOnly: true description: Gets the status. code: type: string readOnly: true description: Gets the code. error: $ref: '#/definitions/Object' readOnly: true description: Gets the error. trackingId: type: string readOnly: true description: Gets the tracking id. correlation: $ref: '#/definitions/Correlation' description: The run correlation. inputsLink: $ref: '#/definitions/ContentLink' readOnly: true description: Gets the link to input parameters. outputsLink: $ref: '#/definitions/ContentLink' readOnly: true description: Gets the link to output parameters. fired: type: boolean readOnly: true description: The value indicating whether trigger was fired. run: $ref: '#/definitions/ResourceReference' readOnly: true description: Gets the reference to workflow run. description: The workflow trigger history properties. WorkflowTriggerHistoryListResult: type: object properties: value: type: array items: $ref: '#/definitions/WorkflowTriggerHistory' description: A list of workflow trigger histories. nextLink: type: string description: The URL to get the next set of results. description: The list of workflow trigger histories. WorkflowTriggerProperties: type: object properties: provisioningState: $ref: '#/definitions/WorkflowTriggerProvisioningState' readOnly: true description: Gets the provisioning state. createdTime: type: string format: date-time readOnly: true description: Gets the created time. changedTime: type: string format: date-time readOnly: true description: Gets the changed time. state: $ref: '#/definitions/WorkflowState' readOnly: true description: Gets the state. status: $ref: '#/definitions/WorkflowStatus' readOnly: true description: Gets the status. lastExecutionTime: type: string format: date-time readOnly: true description: Gets the last execution time. nextExecutionTime: type: string format: date-time readOnly: true description: Gets the next execution time. recurrence: $ref: '#/definitions/WorkflowTriggerRecurrence' readOnly: true description: Gets the workflow trigger recurrence. workflow: $ref: '#/definitions/ResourceReference' readOnly: true description: Gets the reference to workflow. description: The workflow trigger properties. WorkflowTriggerProvisioningState: type: string description: The workflow trigger provisioning state. enum: - NotSpecified - Accepted - Running - Ready - Creating - Created - Deleting - Deleted - Canceled - Failed - Succeeded - Moving - Updating - Registering - Registered - Unregistering - Unregistered - Completed x-ms-enum: name: WorkflowTriggerProvisioningState modelAsString: true WorkflowTriggerListResult: type: object properties: value: type: array items: $ref: '#/definitions/WorkflowTrigger' description: A list of workflow triggers. nextLink: type: string description: The URL to get the next set of results. description: The list of workflow triggers. WorkflowTriggerRecurrence: type: object properties: frequency: $ref: '#/definitions/RecurrenceFrequency' description: The frequency. interval: type: integer format: int32 description: The interval. startTime: type: string description: The start time. endTime: type: string description: The end time. timeZone: type: string description: The time zone. schedule: $ref: '#/definitions/RecurrenceSchedule' description: The recurrence schedule. description: The workflow trigger recurrence. WorkflowVersion: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WorkflowVersionProperties' description: The workflow version properties. description: The workflow version. allOf: - $ref: '#/definitions/WorkflowResource' WorkflowVersionProperties: type: object properties: provisioningState: $ref: '#/definitions/WorkflowProvisioningState' readOnly: true description: The provisioning state. createdTime: type: string format: date-time readOnly: true description: Gets the created time. changedTime: type: string format: date-time readOnly: true description: Gets the changed time. state: $ref: '#/definitions/WorkflowState' description: The state. version: type: string readOnly: true description: Gets the version. accessEndpoint: type: string readOnly: true description: Gets the access endpoint. endpointsConfiguration: $ref: '#/definitions/FlowEndpointsConfiguration' description: The endpoints configuration. accessControl: $ref: '#/definitions/FlowAccessControlConfiguration' description: The access control configuration. sku: $ref: '#/definitions/WorkflowSku' readOnly: true description: The sku. integrationAccount: $ref: '#/definitions/ResourceReference' description: The integration account. definition: $ref: '#/definitions/Object' description: The definition. parameters: type: object additionalProperties: $ref: '#/definitions/WorkflowParameter' description: The parameters. description: The workflow version properties. WorkflowVersionListResult: type: object properties: value: type: array items: $ref: '#/definitions/WorkflowVersion' description: The workflow version. description: A list of workflow versions. nextLink: type: string description: The URL to get the next set of results. description: The list of workflow versions. parameters: siteNameParameter: name: name in: path description: Site name. required: true type: string x-ms-parameter-location: method slotNameParameter: name: slot in: path description: Name of the deployment slot. required: true type: string x-ms-parameter-location: method subscriptionIdParameter: name: subscriptionId in: path description: >- Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). required: true type: string x-ms-parameter-location: client resourceGroupNameParameter: name: resourceGroupName in: path description: Name of the resource group to which the resource belongs. required: true type: string maxLength: 90 minLength: 1 pattern: ^[-\w\._\(\)]+[^\.]$ x-ms-parameter-location: method apiVersionParameter: name: api-version in: query description: API Version required: true type: string x-ms-parameter-location: client securityDefinitions: azure_auth: type: oauth2 description: Azure Active Directory OAuth2 Flow flow: implicit authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize scopes: user_impersonation: impersonate your user account security: - azure_auth: - user_impersonation tags: - name: WebApps - name: WorkflowRunActions - name: WorkflowRuns - name: Workflows - name: WorkflowTriggerHistories - name: WorkflowTriggers - name: WorkflowVersions