Web Apps - Update Site Push Settings
Description for Updates the Push settings associated with web app.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings?api-version=2023-12-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
name
|
path | True |
string |
Name of web app. |
|
resource
|
path | True |
string |
Name of the resource group to which the resource belongs. Regex pattern: |
|
subscription
|
path | True |
string |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
|
api-version
|
query | True |
string |
API Version |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| properties.isPushEnabled | True |
boolean |
Gets or sets a flag indicating whether the Push endpoint is enabled. |
| kind |
string |
Kind of resource. |
|
| properties.dynamicTagsJson |
string |
Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. |
|
| properties.tagWhitelistJson |
string |
Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. |
|
| properties.tagsRequiringAuth |
string |
Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
App Service error response. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Definitions
| Name | Description |
|---|---|
|
Default |
App Service error response. |
| Details | |
| Error |
Error model. |
|
Push |
Push settings for the App. |
DefaultErrorResponse
App Service error response.
| Name | Type | Description |
|---|---|---|
| error |
Error model. |
Details
| Name | Type | Description |
|---|---|---|
| code |
string |
Standardized string to programmatically identify the error. |
| message |
string |
Detailed error description and debugging information. |
| target |
string |
Detailed error description and debugging information. |
Error
Error model.
| Name | Type | Description |
|---|---|---|
| code |
string |
Standardized string to programmatically identify the error. |
| details |
Details[] |
Detailed errors. |
| innererror |
string |
More information to debug error. |
| message |
string |
Detailed error description and debugging information. |
| target |
string |
Detailed error description and debugging information. |
PushSettings
Push settings for the App.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id. |
| kind |
string |
Kind of resource. |
| name |
string |
Resource Name. |
| properties.dynamicTagsJson |
string |
Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. |
| properties.isPushEnabled |
boolean |
Gets or sets a flag indicating whether the Push endpoint is enabled. |
| properties.tagWhitelistJson |
string |
Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. |
| properties.tagsRequiringAuth |
string |
Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler. |
| type |
string |
Resource type. |