You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/app-service/deploy-configure-credentials.md
+27-24Lines changed: 27 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,37 +5,39 @@ author: cephalin
5
5
ms.author: cephalin
6
6
ms.reviewer: byvinyal
7
7
ms.topic: how-to
8
-
ms.date: 06/27/2025
8
+
ms.date: 06/30/2025
9
9
10
10
---
11
11
12
12
# Manage deployment credentials for Azure App Service
13
13
14
-
You can deploy local apps to [Azure App Service](overview.md) by using [local Git deployment](deploy-local-git.md) or [FTP/S deployment](deploy-ftp.md). App Service supports two types of credentials you can use for secure local app deployment,*user-scope* and *app-scope* credentials. These deployment credentials are different from your Azure subscription credentials.
14
+
You can deploy local apps to [Azure App Service](overview.md) by using [local Git deployment](deploy-local-git.md) or [FTP/S deployment](deploy-ftp.md). App Service supports two types of credentials for secure local app deployment:*user-scope* and *app-scope* credentials. These deployment credentials are different from your Azure subscription credentials. This article explains how to create and manage deployment credentials for local Git or FTP/S deployment.
To access, set, or reset deployment user credentials, you must have contributor-level permissions on an App Service app.
20
+
To access, set, or reset deployment user credentials, you must have **Contributor**-level permissions on an App Service app.
21
21
22
22
<aname="disable-basic-authentication"></a>
23
23
### Basic authentication requirement
24
24
25
-
To publish App Service apps via local Git or FTP/S, basic authentication must be enabled. **SCM Basic Auth Publishing Credentials** and **FTP Basic Auth Publishing Credentials** must both be set to **On** on the app's **Configuration** page in the Azure portal.
25
+
To publish App Service apps via local Git or FTP/S, you must enable basic authentication. **SCM Basic Auth Publishing Credentials** and **FTP Basic Auth Publishing Credentials** must both be set to **On** on the app's **Configuration** page in the Azure portal.
26
26
27
27
Basic authentication is less secure than other authentication methods and is disabled by default for new apps. When basic authentication is disabled, you can't view or set deployment credentials in the app's **Deployment Center** or use these credentials for publishing. For more information, see [Disable basic authentication in Azure App Service deployments](configure-basic-auth-disable.md).
28
28
29
29
<aname="userscope"></a>
30
30
## Set user-scope credentials
31
31
32
-
You can configure user-scope credentials by using Azure CLI or the Azure portal.
32
+
Both local Git and FTP/S deployment require a user name. The user name must be unique within Azure.
33
33
34
-
- Both local Git and FTP/S deployment require a user name.
35
-
- The user name must be unique within Azure, and can't contain the `@` character.
36
-
- To authenticate to an FTP/S endpoint, the user name must follow the format `<app-name>\<user-name>`. Since user-scope credentials are linked to the user and not to the app, the username must be in this format to direct the sign-in action to the correct FTP/S endpoint for the app.
34
+
- For local Git, the user name can't contain the `@` character.
37
35
38
-
- For FTP/S deployment only, you also need a password. The password must be at least eight characters and contain capital letters, lowercase letters, numbers, and symbols. The JSON output shows the password as `null`. Local Git deployment doesn't require a password.
36
+
- To authenticate to an FTP/S endpoint, the user name must follow the format `<app-name>\<user-name>`. Since user-scope credentials are linked to the user and not to the app, the username must be in this format to direct the sign-in action to the correct FTP/S endpoint for the app.
37
+
38
+
For FTP/S deployment, you also need a password. The password must be at least eight characters and contain capital letters, lowercase letters, numbers, and symbols. The JSON output shows the password as `null`. Local Git deployment doesn't require a password.
39
+
40
+
You can configure user-scope credentials by using Azure CLI or the Azure portal.
39
41
40
42
# [Azure CLI](#tab/cli)
41
43
@@ -63,14 +65,16 @@ To configure deployment credentials:
63
65
64
66
-----
65
67
66
-
After you set the credentials, you can see your deployment user name on your app's **Overview** page in the Azure portal. If local Git deployment is configured, the label is **Git/deployment username**. Otherwise, the label is **FTP/deployment username**. The page doesn't show the password.
68
+
After you set the credentials, you can see your deployment user name on your app's **Overview** page in the Azure portal. If local Git deployment is configured, the label is **Git/deployment username**. Otherwise, the label is **FTP/deployment username**.
69
+
70
+
The portal doesn't show the password. If you forget your password, you can [reset your credentials](#reset-credentials) to get a new one.
67
71
68
72

69
73
70
74
<aname="appscope"></a>
71
75
## Get application-scope credentials
72
76
73
-
The application-scope credentials are automatically created along with the app. The FTP/S app-scope user name always follows the format `app-name\$app-name`. The local Git user name uses the format `$app-name`.
77
+
The application-scope credentials are automatically created with the app. The FTP/S app-scope user name always follows the format `app-name\$app-name`. The local Git user name uses the format `$app-name`.
74
78
75
79
>[!NOTE]
76
80
>When you use `git remote add` in shells that use the dollar sign for variable interpolation, such as Bash, you must use `\$` to escape any dollar signs in the username or password to avoid authentication errors.
@@ -107,57 +111,56 @@ To get the application-scope credentials:
107
111
108
112
1. In the Azure portal, select **Deployment Center** under **Deployment** in the left navigation menu of your app.
109
113
1. On the **Deployment Center** page, select the **FTPS credentials** or **Local Git/FTPS credentials** tab.
110
-
1. In the **Application-scope** section, view the **FTPS username**, the **Local Git username**, and the**Password**. Select the copy icons to copy the values.
114
+
1. In the **Application-scope** section, view the **FTPS username**, **Local Git username**, and **Password**. Select the copy icons to copy the values.
111
115
112
116
-----
113
117
114
-
## Reset application-scope credentials
118
+
## Reset credentials
115
119
116
-
You can use Azure CLI, Azure PowerShell, or the Azure portal to reset your application-scope deployment credentials and get a new password. The app-scope user names remain at their autogenerated values.
120
+
You can use Azure CLI, Azure PowerShell, or the Azure portal to reset your application-scope deployment credentials and get a new password. The app-scope user names retain their autogenerated values.
117
121
118
122
In Azure CLI and the Azure portal, you can also reset your user-scope credentials by creating new ones. This action affects all the apps in your account that use the user-scope credentials.
119
123
120
-
When you reset your deployment credentials, any external integrations and automation stop working and must be reconfigured with the new values.
124
+
When you reset your deployment credentials, any external integrations and automation via the publishing profile stop working and must be reconfigured with the new values.
121
125
122
126
# [Azure CLI](#tab/cli)
123
127
124
-
Reset the application-scope password by using the [`az resource invoke-action`](/cli/azure/resource#az-resource-invoke-action) command.
128
+
In Azure CLI, reset the application-scope password by using the [`az resource invoke-action`](/cli/azure/resource#az-resource-invoke-action) command.
Reset the user-scope credentials by rerunning the [`az webapp deployment user set`](/cli/azure/webapp/deployment/user#az-webapp-deployment-user-set) command, supplying new user name and password values.
134
+
Reset the user-scope credentials by rerunning the [`az webapp deployment user set`](/cli/azure/webapp/deployment/user#az-webapp-deployment-user-set) command to create new user name and password values.
131
135
132
136
```azurecli-interactive
133
137
az webapp deployment user set --user-name <new-username> --password <new-password>
134
138
```
135
139
136
140
# [Azure PowerShell](#tab/powershell)
137
141
138
-
Reset the application-scope password by using the [`Invoke-AzResourceAction`](/powershell/module/az.resources/invoke-azresourceaction) command:
142
+
In Azure PowerShell, reset the application-scope password by using the [`Invoke-AzResourceAction`](/powershell/module/az.resources/invoke-azresourceaction) command:
From the left navigation menu of your app, select **Deployment Center** > **FTPS credentials** or **Local Git/FTPS credentials**.
150
+
From the left navigation menu of your app in the Azure portal, select **Deployment Center** > **FTPS credentials** or **Local Git/FTPS credentials**.
147
151
148
152
- To reset your app-scope credentials and get a new password, select **Reset** at the bottom of the **Application-scope** section.
149
153
150
154
- To reset your user-scope credentials:
155
+
1. Select **Reset** at the bottom of the **User-scope** section. This selection deletes both user name and password, and disables user-scope credentials.
156
+
1. To reset and reenable your user-scope credentials, enter a new username and password, and select **Save**.
151
157
152
-
1. Select **Reset** at the bottom of the **User-scope** section. This action deletes both user name and password, and disables user-scope credentials.
153
-
1. To reenable and reset your user-scope credentials, enter a new username and password, and select **Save**.
154
-
155
-
This action takes effect across all the apps in your account that use the user-scope credentials.
158
+
This action takes effect across all the apps in your account that use the user-scope credentials.
156
159
157
160
-----
158
161
159
162
## Related content
160
163
161
164
-[Disable basic authentication in Azure App Service deployments](configure-basic-auth-disable.md)
162
165
-[Deploy to Azure App Service by using local Git](deploy-local-git.md)
163
-
-[Deploy your app to Azure App Service using FTP/S](deploy-ftp.md).
166
+
-[Deploy your app to Azure App Service using FTP/S](deploy-ftp.md)
Copy file name to clipboardExpand all lines: includes/app-service-deploy-credentials.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,14 @@
2
2
author: cephalin
3
3
ms.service: azure-app-service
4
4
ms.topic: include
5
-
ms.date: 04/20/2020
5
+
ms.date: 06/30/2025
6
6
ms.author: cephalin
7
7
---
8
8
9
-
-**User-scope credentials**provide a user with one set of deployment credentials for their entire Azure account. A user who is granted app access via role-based access control (RBAC) or coadministrator permissions can use their user-level credentials until access is revoked.
9
+
-**User-scope**or user-level credentials provide one set of deployment credentials for a user's entire Azure account. You can use your user-scope credentials to deploy any app to App Service via local Git or FTP/S in any subscription that your Azure account has permission to access. You don't share these credentials with any other Azure users.
10
10
11
-
You can use your user-scope credentials to deploy any app to App Service via local Git or FTP/S in any subscription that your Azure account has permission to access. You don't share these credentials with other Azure users.
11
+
A user who is granted app access via role-based access control (RBAC) or coadministrator permissions can use their user-level credentials until access is revoked. You can reset your user-scope credentials anytime.
12
12
13
-
-**App-scope credentials** provide one set of credentials per app, which can be used to deploy that app only. The app-scope credentials for each app are generated automatically during app creation and can't be configured manually, but they can be reset anytime.
13
+
-**App-scope**or app-level credentials provide one set of credentials per app, which can be used to deploy that app only. These credentials are generated automatically for each app at creation and can't be configured manually, but the password can be reset anytime.
14
14
15
15
A user must have at least **Contributor** level permissions on an app, including the built-in **Website Contributor** role, to be granted access to app-level credentials via RBAC. **Reader** role can't publish and can't access these credentials.
0 commit comments