Skip to content

Commit 8f9dddb

Browse files
authored
Merge pull request #293233 from MicrosoftDocs/main
1/17/2025 PM Publish
2 parents 8ed5e2b + acb6460 commit 8f9dddb

File tree

170 files changed

+5485
-8796
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

170 files changed

+5485
-8796
lines changed

.openpublishing.redirection.json

Lines changed: 4999 additions & 4794 deletions
Large diffs are not rendered by default.

articles/api-center/register-apis-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ In this section, you set up the GitHub Actions workflow for this scenario:
5353
In the following steps, create a Microsoft Entra ID service principal, which will be used to add credentials to the workflow to authenticate with Azure.
5454

5555
> [!NOTE]
56-
> Configuring a service principal is shown for demonstration purposes. The recommended way to authenticate with Azure for GitHub Actions is with OpenID Connect, an authentication method that uses short-lived tokens. Setting up OpenID Connect with GitHub Actions is more complex but offers hardened security. [Learn more](../app-service/deploy-github-actions.md?tabs=openid%2Caspnetcore#1-generate-deployment-credentials)
56+
> Configuring a service principal is shown for demonstration purposes. The recommended way to authenticate with Azure for GitHub Actions is with OpenID Connect, an authentication method that uses short-lived tokens. Setting up OpenID Connect with GitHub Actions is more complex but offers hardened security. [Learn more](../app-service/deploy-github-actions.md?tabs=openid%2Caspnetcore#generate-deployment-credentials)
5757
5858
Create a service principal using the [az ad sp create-for-rbac](/cli/azure/ad#az-ad-sp-create-for-rbac) command. The following example first uses the [az apic show](/cli/azure/apic#az-apic-show) command to retrieve the resource ID of the API center. The service principal is then created with the Azure API Center Service Contributor role for the API center.
5959

articles/app-service/deploy-continuous-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Specifically, App Service does the following operations:
162162
- Creates the secrets `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, and `AZURE_SUBSCRIPTION_ID` from the federated credential in your selected GitHub repository.
163163
- Assigns the identity to your app.
164164

165-
In a GitHub Actions workflow in your GitHub repository, you can then use the [Azure/login](https://github.com/Azure/login) action to authenticate with your app by using OpenID Connect. For examples, see [Add the workflow file to your GitHub repository](deploy-github-actions.md#3-add-the-workflow-file-to-your-github-repository).
165+
In a GitHub Actions workflow in your GitHub repository, you can then use the [Azure/login](https://github.com/Azure/login) action to authenticate with your app by using OpenID Connect. For examples, see [Add the workflow file to your GitHub repository](deploy-github-actions.md#add-the-workflow-file-to-your-github-repository).
166166

167167
If your Azure account has the [required permissions](#why-do-i-see-the-error-you-do-not-have-sufficient-permissions-on-this-app-to-assign-role-based-access-to-a-managed-identity-and-configure-federated-credentials), App Service creates a user-assigned managed identity and configures it for you. This identity isn't shown in the **Identities** page of your app. If your Azure account doesn't have the required permissions, you must select an [existing identity with the required role](#why-do-i-see-the-error-this-identity-does-not-have-write-permissions-on-this-app-please-select-a-different-identity-or-work-with-your-admin-to-grant-the-website-contributor-role-to-your-identity-on-this-app).
168168

articles/app-service/deploy-github-actions.md

Lines changed: 78 additions & 79 deletions
Large diffs are not rendered by default.

articles/app-service/includes/deploy-github-actions/deploy-github-actions-openid-connect.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ author: cephalin
33
ms.author: cephalin
44
ms.topic: include
55
ms.custom: devx-track-azurecli
6-
ms.date: 01/22/2024
6+
ms.date: 01/16/2025
77
---
88

9-
To deploy with OpenID Connect using the managed identity you configured, use the `azure/login@v1` action with the `client-id`, `tenant-id`, and `subscription-id` keys and reference the GitHub secrets that you [created earlier](../../deploy-github-actions.md?tabs=openid#2-configure-the-github-secret).
9+
To deploy with OpenID Connect using the managed identity you configured, use the `azure/login@v1` action with the `client-id`, `tenant-id`, and `subscription-id` keys. Reference the GitHub secrets that you created earlier.
1010

1111
# [ASP.NET Core](#tab/aspnetcore)
1212

@@ -65,7 +65,7 @@ jobs:
6565
6666
# [ASP.NET](#tab/aspnet)
6767
68-
Build and deploy a ASP.NET MVC app to Azure using an Azure service principal. The example uses GitHub secrets for the `client-id`, `tenant-id`, and `subscription-id` values. You can also pass these values directly in the login action.
68+
Build and deploy a ASP.NET MVC app to Azure using an Azure service principal. The example uses GitHub secrets for the `client-id`, `tenant-id`, and `subscription-id` values. You can also pass these values directly in the sign-in action.
6969

7070
```yaml
7171
name: Deploy ASP.NET MVC App deploy to Azure Web App
@@ -122,7 +122,7 @@ jobs:
122122

123123
# [Java SE](#tab/java)
124124

125-
Build and deploy a Java Spring app to Azure using an Azure service principal. The example uses GitHub secrets for the `client-id`, `tenant-id`, and `subscription-id` values. You can also pass these values directly in the login action.
125+
Build and deploy a Java Spring app to Azure using an Azure service principal. The example uses GitHub secrets for the `client-id`, `tenant-id`, and `subscription-id` values. You can also pass these values directly in the sign-in action.
126126

127127
```yaml
128128
name: Java CI with Maven
@@ -212,7 +212,7 @@ jobs:
212212
package: '*.war'
213213
```
214214

215-
You can find this full example using multiple jobs for build and deploy [here](https://github.com/Azure-Samples/onlinebookstore/blob/master/.github/workflows/azure-webapps-java-war-oidc.yml) as well.
215+
You can find this [full example](https://github.com/Azure-Samples/onlinebookstore/blob/master/.github/workflows/azure-webapps-java-war-oidc.yml) using multiple jobs for build and deploy.
216216

217217
# [Node.js](#tab/nodejs)
218218

@@ -316,4 +316,4 @@ jobs:
316316
az logout
317317
```
318318

319-
-----
319+
---

articles/app-service/includes/deploy-github-actions/deploy-github-actions-publish-profile.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
author: cephalin
33
ms.author: cephalin
44
ms.topic: include
5-
ms.date: 01/22/2024
5+
ms.date: 01/16/2025
66
---
77

8-
The `publish-profile` input should reference the `AZURE_WEBAPP_PUBLISH_PROFILE` GitHub secret that you [created earlier](../../deploy-github-actions.md?tabs=applevel#2-configure-the-github-secret).
8+
The `publish-profile` input should reference the `AZURE_WEBAPP_PUBLISH_PROFILE` GitHub secret that you created earlier.
99

1010
# [ASP.NET Core](#tab/aspnetcore)
1111

@@ -51,8 +51,7 @@ jobs:
5151
5252
# [ASP.NET](#tab/aspnet)
5353
54-
Build and deploy an ASP.NET MVC app that uses NuGet and `publish-profile` for authentication.
55-
54+
Build and deploy an ASP.NET MVC app that uses NuGet and `publish-profile` for authentication.
5655

5756
```yaml
5857
name: Deploy ASP.NET MVC App deploy to Azure Web App
@@ -123,7 +122,7 @@ jobs:
123122
package: my/target/*.jar
124123
```
125124

126-
To deploy a `war` instead of a `jar`, change the `package` value.
125+
To deploy a `war` instead of a `jar`, change the `package` value.
127126

128127

129128
```yaml
@@ -179,7 +178,7 @@ jobs:
179178
package: '*.war'
180179
```
181180

182-
You can find this full example using multiple jobs for build and deploy [here](https://github.com/Azure-Samples/onlinebookstore/blob/master/.github/workflows/azure-webapps-java-war-publish-profile.yml) as well.
181+
You can find this [full example](https://github.com/Azure-Samples/onlinebookstore/blob/master/.github/workflows/azure-webapps-java-war-publish-profile.yml) using multiple jobs for build and deploy.
183182

184183
# [Node.js](#tab/nodejs)
185184

articles/app-service/includes/deploy-github-actions/deploy-github-actions-service-principal.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ author: cephalin
33
ms.author: cephalin
44
ms.topic: include
55
ms.custom: devx-track-azurecli
6-
ms.date: 01/22/2024
6+
ms.date: 01/16/2025
77
---
88

9-
To deploy with the service principal you configured, use the `azure/login@v1` action with the `creds` key and reference the `AZURE_CREDENTIALS` secret that you [created earlier](../../deploy-github-actions.md?tabs=userlevel#2-configure-the-github-secret).
9+
To deploy with the service principal you configured, use the `azure/login@v1` action with the `creds` key and reference the `AZURE_CREDENTIALS` secret that you created earlier.
1010

1111
# [ASP.NET Core](#tab/aspnetcore)
1212

@@ -59,7 +59,7 @@ jobs:
5959
6060
# [ASP.NET](#tab/aspnet)
6161
62-
Build and deploy a ASP.NET MVC app to Azure using an Azure service principal. Note how the `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
62+
Build and deploy a ASP.NET MVC app to Azure using an Azure service principal. The `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
6363

6464
```yaml
6565
name: Deploy ASP.NET MVC App deploy to Azure Web App
@@ -110,7 +110,7 @@ jobs:
110110

111111
# [Java SE](#tab/java)
112112

113-
Build and deploy a Java Spring app to Azure using an Azure service principal. Note how the `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
113+
Build and deploy a Java Spring app to Azure using an Azure service principal. The `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
114114

115115
```yaml
116116
name: Java CI with Maven
@@ -148,7 +148,7 @@ jobs:
148148

149149
# [Tomcat](#tab/tomcat)
150150

151-
Build and deploy a Tomcat app to Azure using an Azure service principal. Note how the `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
151+
Build and deploy a Tomcat app to Azure using an Azure service principal. The `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
152152

153153
```yaml
154154
name: Build and deploy WAR app to Azure Web App using Service Principal Connect
@@ -193,11 +193,11 @@ jobs:
193193
package: '*.war'
194194
```
195195

196-
You can find this full example using multiple jobs for build and deploy [here](https://github.com/Azure-Samples/onlinebookstore/blob/master/.github/workflows/azure-webapps-java-war-service-principal.yml) as well.
196+
You can find this [full example](https://github.com/Azure-Samples/onlinebookstore/blob/master/.github/workflows/azure-webapps-java-war-service-principal.yml) using multiple jobs for build and deploy.
197197

198198
# [Node.js](#tab/nodejs)
199199

200-
Build and deploy a Node.js app to Azure using an Azure service principal. Note how the `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
200+
Build and deploy a Node.js app to Azure using an Azure service principal. The `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
201201

202202
```yaml
203203
name: JavaScript CI
@@ -249,7 +249,7 @@ jobs:
249249

250250
# [Python](#tab/python)
251251

252-
Build and deploy a Python app to Azure using an Azure service principal. Note how the `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
252+
Build and deploy a Python app to Azure using an Azure service principal. The `creds` input references the `AZURE_CREDENTIALS` secret that you created earlier.
253253

254254
```yaml
255255
name: Python application
-237 KB
Loading

articles/app-service/tutorial-connect-msi-azure-database.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ The following Azure CLI command uses a `--client-type` parameter.
172172
173173
1. Grant permission to pre-created tables
174174
175-
[!INCLUDE [Postgresql grant permission](../service-connector/includes/postgres-grant-permission.md)]
175+
[!INCLUDE [PostgreSQL grant permission](../service-connector/includes/postgres-grant-permission.md)]
176176
177177
-----
178178

articles/app-service/tutorial-multi-region-app.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ A default workflow file that uses a publish profile to authenticate to App Servi
332332

333333
### How do I disable basic authentication on App Service?
334334

335-
Consider [disabling basic authentication](configure-basic-auth-disable.md), which limits access to the FTP and SCM endpoints to users that are backed by Microsoft Entra ID. If using a continuous deployment tool to deploy your application source code, disabling basic authentication requires [extra steps to configure continuous deployment](deploy-github-actions.md). For example, you can't use a publish profile since it doesn't use Microsoft Entra credentials. Instead, you need to use either a [service principal or OpenID Connect](deploy-github-actions.md#1-generate-deployment-credentials).
335+
Consider [disabling basic authentication](configure-basic-auth-disable.md), which limits access to the FTP and SCM endpoints to users that are backed by Microsoft Entra ID. If using a continuous deployment tool to deploy your application source code, disabling basic authentication requires [extra steps to configure continuous deployment](deploy-github-actions.md). For example, you can't use a publish profile since it doesn't use Microsoft Entra credentials. Instead, you need to use either a [service principal or OpenID Connect](deploy-github-actions.md#generate-deployment-credentials).
336336

337337
To disable basic authentication for your App Service, run the following commands for each app and slot by replacing the placeholders for `<web-app-east-us>` and `<web-app-west-us>` with your app names. The first set of commands disables FTP access for the production sites and staging slots, and the second set of commands disables basic auth access to the WebDeploy port and SCM site for the production sites and staging slots.
338338

@@ -387,7 +387,7 @@ To configure continuous deployment with GitHub Actions and a service principal,
387387

388388
#### Create the GitHub Actions workflow
389389

390-
Now that you have a service principal that can access your App Service apps, edit the default workflows that were created for your apps when you configured continuous deployment. Authentication must be done using your service principal instead of the publish profile. For sample workflows, see the "Service principal" tab in [Add the workflow file to your GitHub repository](deploy-github-actions.md?tabs=userlevel#3-add-the-workflow-file-to-your-github-repository). The following sample workflow can be used for the Node.js sample app that was provided.
390+
Now that you have a service principal that can access your App Service apps, edit the default workflows that were created for your apps when you configured continuous deployment. Authentication must be done using your service principal instead of the publish profile. For sample workflows, see the "Service principal" tab in [Add the workflow file to your GitHub repository](deploy-github-actions.md?tabs=userlevel#add-the-workflow-file-to-your-github-repository). The following sample workflow can be used for the Node.js sample app that was provided.
391391

392392
1. Open your app's GitHub repository and go to the `<repo-name>/.github/workflows/` directory. You should see the autogenerated workflows.
393393
1. For each workflow file, select the "pencil" button in the top right to edit the file. Replace the contents with the following text, which assumes you created the GitHub secrets earlier for your credential. Update the placeholder for `<web-app-name>` under the "env" section, and then commit directly to the main branch. This commit triggers the GitHub Action to run again and deploy your code, this time using the service principal to authenticate.

0 commit comments

Comments
 (0)