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
description: Learn what types of deployment credentials are in Azure App Service and how to configure and use them.
4
-
5
-
ms.topic: article
6
-
ms.date: 01/26/2024
7
-
ms.reviewer: byvinyal
8
4
author: cephalin
9
5
ms.author: cephalin
6
+
ms.reviewer: byvinyal
7
+
ms.topic: how-to
8
+
ms.date: 01/26/2024
9
+
10
10
---
11
11
12
12
# Configure deployment credentials for Azure App Service
13
-
To secure app deployment from a local computer, [Azure App Service](./overview.md) supports two types of credentials for [local Git deployment](deploy-local-git.md)
14
-
and [FTP/S deployment](deploy-ftp.md). These credentials are not the same as your Azure subscription credentials.
13
+
To secure app deployment from a local computer, [Azure App Service](./overview.md) supports two types of credentials for [local Git deployment](deploy-local-git.md) and [FTP/FTPS deployment](deploy-ftp.md). These credentials are different from your Azure subscription credentials.
> When [basic authentication is disabled](configure-basic-auth-disable.md), you can't view or configure deployment credentials in the Deployment Center.
18
+
> When [basic authentication is disabled](configure-basic-auth-disable.md), you can't view or configure deployment credentials in **Deployment Center**.
Run the [az webapp deployment user set](/cli/azure/webapp/deployment/user#az-webapp-deployment-user-set) command. Replace \<username> and \<password> with a deployment user username and password.
24
+
Run the [`az webapp deployment user set`](/cli/azure/webapp/deployment/user#az-webapp-deployment-user-set) command. Replace `<username>` and `<password>` with a deployment user's username and password.
26
25
27
-
- The username must be unique within Azure, and for local Git pushes, must not contain the ‘@’ symbol.
28
-
- The password must be at least eight characters long, with two of the following three elements: letters, numbers, and symbols.
26
+
- The username must be unique within Azure, and for local Git pushes, must not contain the @ symbol.
27
+
- The password must be at least eight characters long, with two of the following three elements: letters, numbers, and symbols.
29
28
30
29
```azurecli-interactive
31
30
az webapp deployment user set --user-name <username> --password <password>
@@ -35,70 +34,66 @@ The JSON output shows the password as `null`.
35
34
36
35
# [Azure PowerShell](#tab/powershell)
37
36
38
-
You can't configure the user-scope credentials with Azure PowerShell. Use a different method, or consider [using application-scope credentials](#appscope).
37
+
You can't configure the user-scope credentials by using Azure PowerShell. Use a different method, or consider [using application-scope credentials](#appscope).
39
38
40
39
# [Azure portal](#tab/portal)
41
40
42
-
You can configure your user-scope credentials in any app's [resource page](../azure-resource-manager/management/manage-resources-portal.md#manage-resources). Regardless in which app you configure these credentials, it applies to all apps for all subscriptions in your Azure account.
41
+
You can configure your user-scope credentials in any app's [resource page](../azure-resource-manager/management/manage-resources-portal.md#manage-resources). Regardless of which app you use to configure these credentials, the credentials apply to all apps for all subscriptions in your Azure account.
43
42
44
-
In the [Azure portal](https://portal.azure.com), you must have at least one app before you can access the deployment credentials page. To configure your user-scope credentials:
43
+
You must have at least one app in the [Azure portal](https://portal.azure.com) before you can access the deployment credentials page. To configure your user-scope credentials:
45
44
46
-
1. From the left menu of your app, select > **Deployment center** > **FTPS credentials** or **Local Git/FTPS credentials**.
47
-
48
-
45
+
1. From the left menu of your app, select > **Deployment Center** > **FTPS credentials** or **Local Git/FTPS credentials**.
49
46
50
47
2. Scroll down to **User scope**, configure the **Username** and **Password**, and then select **Save**.
51
48
52
-
Once you have set your deployment credentials, you can find the *Git* deployment username in your app's **Overview** page,
49
+
After you set your deployment credentials, you can find the Git deployment username in your app's **Overview** page.
53
50
54
-
51
+
55
52
56
-
If Git deployment is configured, the page shows a **Git/deployment username**; otherwise, an**FTP/deployment username**.
53
+
If Git deployment is configured, the page shows **Git/deployment username**. Otherwise, it shows**FTP/deployment username**.
57
54
58
55
> [!NOTE]
59
-
> Azure does not show your user-scope deployment password. If you forget the password, you can reset your credentials by following the steps in this section.
60
-
>
61
-
>
56
+
> Azure doesn't show your user-scope deployment password. If you forget the password, you can follow the steps in this section to reset your credentials.
62
57
63
58
-----
64
59
65
60
## Use user-scope credentials with FTP/FTPS
66
61
67
-
Authenticating to an FTP/FTPS endpoint using user-scope credentials requires a username in the following format:
62
+
To authenticate to an FTP/FTPS endpoint by using user-scope credentials, your username must follow this format:
68
63
`<app-name>\<user-name>`
69
64
70
-
Since user-scope credentials are linked to the user and not a specific resource, the username must be in this format to direct the sign-in action to the right app endpoint.
65
+
Since user-scope credentials are linked to the user and not to a specific resource, the username must be in this format to direct the sign-in action to the right app endpoint.
Get the application-scope credentials using the [az webapp deployment list-publishing-profiles](/cli/azure/webapp/deployment#az-webapp-deployment-list-publishing-profiles) command. For example:
71
+
Get the application-scope credentials by using the [`az webapp deployment list-publishing-profiles`](/cli/azure/webapp/deployment#az-webapp-deployment-list-publishing-profiles) command. For example:
77
72
78
73
```azurecli-interactive
79
74
az webapp deployment list-publishing-profiles --resource-group <group-name> --name <app-name>
80
75
```
81
76
82
-
For [local Git deployment](deploy-local-git.md), you can also use the [az webapp deployment list-publishing-credentials](/cli/azure/webapp/deployment#az-webapp-deployment-list-publishing-credentials) command to get a Git remote URI for your app, with the application-scope credentials already embedded. For example:
77
+
For [local Git deployment](deploy-local-git.md), you can also use the [`az webapp deployment list-publishing-credentials`](/cli/azure/webapp/deployment#az-webapp-deployment-list-publishing-credentials) command. When you use this command, you get a Git remote URI for your app that has the application-scope credentials already embedded. For example:
83
78
84
79
```azurecli-interactive
85
80
az webapp deployment list-publishing-credentials --resource-group <group-name> --name <app-name> --query scmUri
86
81
```
87
-
Note that the returned Git remote URI doesn't contain `/<app-name>.git` at the end. When you add the remote URI, make sure to append `/<app-name>.git` to avoid an error 22 with `git-http-push`. Additionally, when using `git remote add ... ` via shells that use the dollar sign for variable interpolation (such as bash), escape any dollar signs (`\$`) in the username or password. Failure to escape this character can result in authentication errors.
82
+
83
+
> [!NOTE]
84
+
> The returned Git remote URI doesn't contain `/<app-name>.git` at the end. When you add the remote URI, make sure to append `/<app-name>.git` to avoid an error 22 with `git-http-push`. Additionally, when using `git remote add ... ` via shells that use the dollar sign for variable interpolation (such as bash), escape any dollar signs `\$` in the username or password. Failure to escape this character can result in authentication errors.
88
85
89
86
# [Azure PowerShell](#tab/powershell)
90
87
91
-
Get the application-scope credentials using the [Get-AzWebAppPublishingProfile](/powershell/module/az.websites/get-azwebapppublishingprofile) command. For example:
88
+
Get the application-scope credentials by using the [`Get-AzWebAppPublishingProfile`](/powershell/module/az.websites/get-azwebapppublishingprofile) command. For example:
1. From the left menu of your app, select **Deployment center** > **FTPS credentials** or **Local Git/FTPS credentials**.
100
-
101
-
96
+
1. From the left menu of your app, select **Deployment Center** > **FTPS credentials** or **Local Git/FTPS credentials**.
102
97
103
98
2. In the **Application scope** section, select the **Copy** link to copy the username or password.
1. From the left menu of your app, select **Deployment center** > **FTPS credentials** or **Local Git/FTPS credentials**.
128
-
129
-
122
+
1. From the left menu of your app, select **Deployment Center** > **FTPS credentials** or **Local Git/FTPS credentials**.
130
123
131
124
2. In the **Application scope** section, select **Reset**.
132
125
133
126
-----
134
127
135
128
## Disable basic authentication
136
129
137
-
See [Disable basic authentication in App Service deployments](configure-basic-auth-disable.md).
130
+
See [Disable basic authentication in App Service deployment](configure-basic-auth-disable.md).
138
131
139
-
## Next steps
132
+
## Related content
140
133
141
-
Find out how to use these credentials to deploy your app from [local Git](deploy-local-git.md) or using [FTP/S](deploy-ftp.md).
134
+
Find out how to use these credentials to deploy your app from a [local Git](deploy-local-git.md) or by using [FTP/FTPS](deploy-ftp.md).
0 commit comments