diff --git a/articles/github/breadcrumb/toc.yml b/articles/github/breadcrumb/toc.yml deleted file mode 100644 index b6c8b9a7f4..0000000000 --- a/articles/github/breadcrumb/toc.yml +++ /dev/null @@ -1,12 +0,0 @@ -items: -- name: Azure - tocHref: /azure/index - topicHref: /azure/index - items: - - name: Developer - tocHref: /azure/developer - topicHref: /azure/developer/index - items: - - name: GitHub - tocHref: /azure - topicHref: /azure/developer/github/index diff --git a/articles/github/build-vm-image.md b/articles/github/build-vm-image.md deleted file mode 100644 index 3b82bcca56..0000000000 --- a/articles/github/build-vm-image.md +++ /dev/null @@ -1,426 +0,0 @@ ---- -title: Build custom virtual machine images with GitHub Actions and Azure -description: Learn how to build custom virtual machine images with GitHub Actions and Azure -author: juliakm -ms.author: jukullam -ms.topic: quickstart -ms.service: azure-virtual-machines -ms.subservice: imaging -ms.date: 02/12/2025 -ms.custom: github-actions-azure, devx-track-azurecli, mode-portal, devx-track-extended-java, linux-related-content ---- - - -# Build custom virtual machine images with GitHub Actions and Azure - -Get started with the [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions) by creating a workflow to build a virtual machine image. - - -With GitHub Actions, you can speed up your CI/CD process by creating custom virtual machine images with artifacts from your workflows. You can both build images and distribute them to a [Shared Image Gallery](/azure/virtual-machines/shared-image-galleries). - - You can then use these images to create [virtual machines](https://azure.microsoft.com/services/virtual-machines/) and [virtual machine scale sets](/azure/virtual-machine-scale-sets/overview). - -The build virtual machine image action uses the [Azure Image Builder service](/azure/virtual-machines/image-builder-overview). - -## Prerequisites - -- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F). -- A GitHub account with an active repository. If you don't have one, sign up for [free](https://github.com/join). - - This example uses the [Java Spring PetClinic Sample Application](https://github.com/spring-projects/spring-petclinic). -- An Azure Compute Gallery with an image. - - [Create an Azure Compute Gallery](/azure/virtual-machines/create-gallery?tabs=cli). - - [Create an image](/azure/virtual-machines/image-version). - - -## Workflow file overview - -A workflow is defined by a YAML (.yml) file in the `/.github/workflows/` path in your repository. This definition contains the various steps and parameters that make up the workflow. - -The file has three sections: - -|Section |Tasks | -|---------|---------| -|**Authentication** | 1. Add a user-managed identity.
2. Set up a service principal or Open ID Connect.
3. Create a GitHub secret. | -|**Build** | 1. Set up the environment.
2. Build the app. | -|**Image** | 1. Create a VM Image.
2. Create a virtual machine. | - - -## Create a user-managed identity - -You'll need a user-managed identity for Azure Image Builder(AIB) to distribute images. Your Azure user-assigned managed identity will be used during the image build to read and write images to a Shared Image Gallery. - -1. Create a user-managed identity with [Azure CLI](/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-cli) or the [Azure portal](/azure/active-directory/managed-identities-azure-resources/how-to-manage-ua-identity-portal). Write down the name of your managed identity. - -1. Customize this JSON code. Replace the placeholders for `{subscriptionID}` and `{rgName}`with your subscription ID and resource group name. - - ```yaml - { - "properties": { - "roleName": "Image Creation Role", - "IsCustom": true, - "description": "Azure Image Builder access to create resources for the image build", - "assignableScopes": [ - "/subscriptions/{subscriptionID}/resourceGroups/{rgName}" - ], - "permissions": [ - { - "actions": [ - "Microsoft.Compute/galleries/read", - "Microsoft.Compute/galleries/images/read", - "Microsoft.Compute/galleries/images/versions/read", - "Microsoft.Compute/galleries/images/versions/write", - "Microsoft.Compute/images/write", - "Microsoft.Compute/images/read", - "Microsoft.Compute/images/delete" - ], - "notActions": [], - "dataActions": [], - "notDataActions": [] - } - ] - } - } - ``` - -1. Use this JSON code to create a [new custom role](/azure/role-based-access-control/custom-roles-portal#start-from-scratch#start-from-json) with JSON. - -1. In Azure portal, open your Azure Compute Gallery and go to **Access control (IAM)**. - -1. Select **Add role assignment** and assign the Image Creation Role to your user-managed identity. - -## Generate deployment credentials - -[!INCLUDE [include](~/../articles/reusable-content/github-actions/generate-deployment-credentials.md)] - -## Create GitHub secrets - -[!INCLUDE [include](~/../articles/reusable-content/github-actions/create-secrets-with-openid.md)] - - -## Use the Azure login action - -Use your GitHub secret with the [Azure Login action](https://github.com/Azure/login) to authenticate to Azure. - -# [OpenID Connect](#tab/openid) - -For Open ID Connect you'll use a federated credential associated with your Active Directory app. - -For more information about referencing GitHub secrets in a workflow file, see [Using encrypted secrets in a workflow](https://docs.github.com/en/actions/reference/encrypted-secrets#using-encrypted-secrets-in-a-workflow) in GitHub Docs. - - -```yaml -on: [push] - -name: Create Custom VM Image - -jobs: - build-image: - runs-on: ubuntu-latest - steps: - - name: Log in with Azure - uses: azure/login@v2 - with: - client-id: ${{ secrets.AZURE_CLIENT_ID }} - tenant-id: ${{ secrets.AZURE_TENANT_ID }} - subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} -``` - -# [Service principal](#tab/userlevel) - -In this workflow, you authenticate using the Azure login action with the service principal details stored in `secrets.AZURE_CREDENTIALS`. Then, you run an Azure CLI action. For more information about referencing GitHub secrets in a workflow file, see [Using encrypted secrets in a workflow](https://docs.github.com/en/actions/reference/encrypted-secrets#using-encrypted-secrets-in-a-workflow) in GitHub Docs. - - -```yaml -on: [push] - -name: Create Custom VM Image - -jobs: - build-image: - runs-on: ubuntu-latest - steps: - - name: Log in with Azure - uses: azure/login@v2 - with: - creds: '${{ secrets.AZURE_CREDENTIALS }}' -``` - -___ - -## Configure Java - -Set up the Java environment with the [Java Setup SDK action](https://github.com/marketplace/actions/setup-java-jdk). For this example, you'll set up the environment, build with Maven, and then output an artifact. - -[GitHub artifacts](https://docs.github.com/en/actions/guides/storing-workflow-data-as-artifacts) are a way to share files in a workflow between jobs. You'll create an artifact to hold the JAR file and then add it to the virtual machine image. - -# [OpenID Connect](#tab/openid) - -```yaml -on: [push] - -name: Create Custom VM Image - -jobs: - build-image: - runs-on: ubuntu-latest - strategy: - matrix: - java: [ '17' ] - - steps: - - name: Checkout - uses: actions/checkout@v3 - - - name: Login via Az module - uses: azure/login@v2 - with: - creds: ${{secrets.AZURE_CREDENTIALS}} - - - name: Set up JDK ${{matrix.java}} - uses: actions/setup-java@v2 - with: - java-version: ${{matrix.java}} - distribution: 'adopt' - cache: maven - - name: Build with Maven Wrapper - run: ./mvnw -B package - - - name: Build Java - run: mvn --batch-mode --update-snapshots verify - - - run: mkdir staging && cp target/*.jar staging - - uses: actions/upload-artifact@v2 - with: - name: Package - path: staging -``` - -# [Service principal](#tab/userlevel) - -```yaml -on: [push] - -name: Create Custom VM Image - -jobs: - build-image: - runs-on: ubuntu-latest - strategy: - matrix: - java: [ '17' ] - - steps: - - name: Checkout - uses: actions/checkout@v3 - - - name: Login via Az module - uses: azure/login@v2 - with: - creds: ${{secrets.AZURE_CREDENTIALS}} - - - name: Set up JDK ${{matrix.java}} - uses: actions/setup-java@v2 - with: - java-version: ${{matrix.java}} - distribution: 'adopt' - cache: maven - - name: Build with Maven Wrapper - run: ./mvnw -B package - - - name: Build Java - run: mvn --batch-mode --update-snapshots verify - - - run: mkdir staging && cp target/*.jar staging - - uses: actions/upload-artifact@v2 - with: - name: Package - path: staging -``` -___ - -## Build your image - -Use the [Build Azure Virtual Machine Image action](https://github.com/marketplace/actions/build-azure-virtual-machine-image) to create a custom virtual machine image. - -Replace the placeholders for `{subscriptionID}`, `{rgName}`and `{Identity}` with your subscription ID, resource group name, and managed identity name. Replace the values of `{galleryName}` and `{imageName}` with your image gallery name and your image name. - -> [!NOTE] -> If the Create App Baked Image action fails with a permission error, verify that you have assigned the Image Creation Role to your user-managed identity. - - - -```yaml - - name: Create App Baked Image - id: imageBuilder - uses: azure/build-vm-image@v0 - with: - location: 'eastus2' - resource-group-name: '{rgName}' - managed-identity: '{Identity}' # Managed identity - source-os-type: 'windows' - source-image-type: 'platformImage' - source-image: MicrosoftWindowsServer:WindowsServer:2019-Datacenter:latest #unique identifier of source image - dist-type: 'SharedImageGallery' - dist-resource-id: '/subscriptions/{subscriptionID}/resourceGroups/{rgName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/0.1.${{ GITHUB.RUN_ID }}' #Replace with the resource id of your shared image gallery's image definition - dist-location: 'eastus2' -``` - -### Virtual Machine action arguments - -| Input | Required | Description | -|---|---|---| -| `resource-group-name` | Yes | The resource group used for storage and saving artifacts during the build process. | -| `image-builder-template-name` | No | The name of the image builder template resource used. | -| `location` | Yes | The location where Azure Image Builder will run. See [supported locations](/azure/virtual-machines/image-builder-overview#regions). | -| `build-timeout-in-minutes` | No | Time after which the build is canceled. Defaults to 240. | -| `vm-size` | Optional | By default, `Standard_D1_v2` will be used. See [virtual machine sizes](/azure/virtual-machines/sizes).| -| `managed-identity` | Yes | The user-managed identity you created earlier. Use the full identifier if your identity is in a different resources group. Use the name if it is in the same resource group. | -| `source-os` | Yes | The OS type of the base image (Linux or Windows) | -| `source-image-type` | Yes | The base image type that will be used for creating the custom image. | -| `source-image` | Yes | The resource identifier for base image. A source image should be present in the same Azure region set in the input value of location. | -| `customizer-source` | No | The directory where you can keep all the artifacts that need to be added to the base image for customization. By default, the value is `${{ GITHUB.WORKSPACE }}/workflow-artifacts.` | -| `customizer-destination` | No | This is the directory in the customized image where artifacts are copied to. | -| `customizer-windows-update` | No | For Windows only. Boolean value. If `true`, the image builder will run Windows update at the end of the customizations.| -| `dist-location` | No | For SharedImageGallery, this is the `dist-type`.| -| `dist-image-tags` | No | These are user-defined tags that are added to the custom image created (example: `version:beta`). | - - -## Create your virtual machine - -As a last step, create a virtual machine from your image. - -1. Replace the placeholders for `{rgName}`with your resource group name. - -1. Add a GitHub secret with the virtual machine password (`VM_PWD`). Be sure to write down the password because you will not be able to see it again. The username is `myuser`. - -```yaml - - name: CREATE VM - uses: azure/CLI@v1 - with: - azcliversion: 2.0.72 - inlineScript: | - az vm create --resource-group ghactions-vMimage --name "app-vm-${{ GITHUB.RUN_NUMBER }}" --admin-username myuser --admin-password "${{ secrets.VM_PWD }}" --location eastus2 \ - --image "${{ steps.imageBuilder.outputs.custom-image-uri }}" -``` - -### Complete YAML - -# [OpenID Connect](#tab/openid) - -```yaml - on: [push] - - name: Create Custom VM Image - - jobs: - build-image: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v2 - - - name: Login via Az module - uses: azure/login@v2 - with: - client-id: ${{ secrets.AZURE_CLIENT_ID }} - tenant-id: ${{ secrets.AZURE_TENANT_ID }} - subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} - - - name: Setup Java 1.8.x - uses: actions/setup-java@v1 - with: - java-version: '1.8.x' - - - name: Build Java - run: mvn --batch-mode --update-snapshots verify - - - run: mkdir staging && cp target/*.jar staging - - uses: actions/upload-artifact@v2 - with: - name: Package - path: staging - - - name: Create App Baked Image - id: imageBuilder - uses: azure/build-vm-image@v0 - with: - location: 'eastus2' - resource-group-name: '{rgName}' - managed-identity: '{Identity}' # Managed identity - source-os-type: 'windows' - source-image-type: 'platformImage' - source-image: MicrosoftWindowsServer:WindowsServer:2019-Datacenter:latest #unique identifier of source image - dist-type: 'SharedImageGallery' - dist-resource-id: '/subscriptions/{subscriptionID}/resourceGroups/{rgName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/0.1.${{ GITHUB.RUN_ID }}' #Replace with the resource id of your shared image gallery's image definition - dist-location: 'eastus2' - - - name: CREATE VM - uses: azure/CLI@v1 - with: - azcliversion: 2.0.72 - inlineScript: | - az vm create --resource-group ghactions-vMimage --name "app-vm-${{ GITHUB.RUN_NUMBER }}" --admin-username myuser --admin-password "${{ secrets.VM_PWD }}" --location eastus2 \ - --image "${{ steps.imageBuilder.outputs.custom-image-uri }}" -``` - -# [Service principal](#tab/userlevel) - -```yaml - on: [push] - - name: Create Custom VM Image - - jobs: - build-image: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v2 - - - name: Login via Az module - uses: azure/login@v2 - with: - creds: ${{secrets.AZURE_CREDENTIALS}} - - - name: Setup Java 1.8.x - uses: actions/setup-java@v1 - with: - java-version: '1.8.x' - - - name: Build Java - run: mvn --batch-mode --update-snapshots verify - - - run: mkdir staging && cp target/*.jar staging - - uses: actions/upload-artifact@v2 - with: - name: Package - path: staging - - - name: Create App Baked Image - id: imageBuilder - uses: azure/build-vm-image@v0 - with: - location: 'eastus2' - resource-group-name: '{rgName}' - managed-identity: '{Identity}' # Managed identity - source-os-type: 'windows' - source-image-type: 'platformImage' - source-image: MicrosoftWindowsServer:WindowsServer:2019-Datacenter:latest #unique identifier of source image - dist-type: 'SharedImageGallery' - dist-resource-id: '/subscriptions/{subscriptionID}/resourceGroups/{rgName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}/versions/0.1.${{ GITHUB.RUN_ID }}' #Replace with the resource id of your shared image gallery's image definition - dist-location: 'eastus2' - - - name: CREATE VM - uses: azure/CLI@v1 - with: - azcliversion: 2.0.72 - inlineScript: | - az vm create --resource-group ghactions-vMimage --name "app-vm-${{ GITHUB.RUN_NUMBER }}" --admin-username myuser --admin-password "${{ secrets.VM_PWD }}" --location eastus2 \ - --image "${{ steps.imageBuilder.outputs.custom-image-uri }}" -``` - ---- - - -## Next steps -- Learn how to [deploy to Azure](deploy-to-azure.md). diff --git a/articles/github/connect-from-azure-identity.md b/articles/github/connect-from-azure-identity.md deleted file mode 100644 index 831690fc19..0000000000 --- a/articles/github/connect-from-azure-identity.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: Authenticate to Azure from GitHub by a managed identity -description: Securely authenticate to Azure services from GitHub Actions workflows using Azure Login action with a managed identity configured on a virtual machine. -author: MoChilia -ms.author: shiyingchen -ms.topic: reference -ms.service: azure -ms.date: 07/01/2024 -ms.custom: github-actions-azure, devx-track-azurecli, devx-track-azurepowershell, linux-related-content ---- - -# Use the Azure Login action with a managed identity - -On a virtual machine configured with [managed identities](/entra/identity/managed-identities-azure-resources/overview) in Azure, you can sign in [Azure Login action](https://github.com/marketplace/actions/azure-login) using the managed identity. You don't need to manage credentials, as they aren't accessible to you. There are two types of managed identities for you to choose: [**system-assigned managed identities**](/entra/identity/managed-identities-azure-resources/how-to-configure-managed-identities#system-assigned-managed-identity) or [**user-assigned managed identities**](/entra/identity/managed-identities-azure-resources/how-to-configure-managed-identities#user-assigned-managed-identity). - -In this tutorial, you learn how to: - -> [!div class="checklist"] -> * Create GitHub secrets for system/user-assigned managed identity -> * Set up Azure Login for system/user-assigned managed identity in GitHub Actions workflows - -> [!NOTE] -> -> Login with managed identity is only supported for self-hosted runners on Azure virtual machines. For other users, please refer to [Sign in with OpenID Connect](connect-from-azure-openid-connect.md) or [Sign in with a service principal and secret](connect-from-azure-secret.md). - -## Prerequisites - -- Create an Azure virtual machine - - [Create a Windows virtual machine](/azure/virtual-machines/windows/quick-create-portal) - - [Create a Linux virtual machine](/azure/virtual-machines/linux/quick-create-portal?tabs=ubuntu) -- [Configure managed identity on the Azure virtual machine](/entra/identity/managed-identities-azure-resources/qs-configure-portal-windows-vm) -- Install required software on the Azure virtual machine - - [Install Azure CLI](/cli/azure/install-azure-cli) - - [install Docker](https://docs.docker.com/engine/install/) - - [Install PowerShell](/powershell/scripting/install/installing-powershell) - - [Install Azure PowerShell](/powershell/azure/install-azure-powershell) -- [Configure the Azure virtual machine as a GitHub self-hosted runner](https://docs.github.com/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners) - - -## Use the Azure Login action with system-assigned managed identity - -Learn how to securely authenticate to Azure services from GitHub Actions workflows using [Azure Login action](https://github.com/marketplace/actions/azure-login) with [system-assigned managed identity](/entra/identity/managed-identities-azure-resources/how-to-configure-managed-identities#system-assigned-managed-identity) that configured on a virtual machine. - -### Create GitHub secrets for system-assigned managed identity - -1. Open your GitHub repository and go to **Settings**. - :::image type="content" source="media/github-repo-settings.png" alt-text="Select settings tab in GitHub repository."::: - -1. Select **Security > Secrets and variables > Actions > New repository secret**. - :::image type="content" source="media/github-repo-secrets.png" alt-text="Select Security > Secrets and variables > Actions."::: - - > [!NOTE] - > To enhance workflow security in public repositories, use [environment secrets](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets) instead of repository secrets. If the environment requires approval, a job cannot access environment secrets until one of the required reviewers approves it. - -1. Create secrets for `AZURE_TENANT_ID`, and `AZURE_SUBSCRIPTION_ID`. Copy these values from your user-assigned managed identity for your GitHub secrets: - - |GitHub secret |System-assigned managed identity | - |---------|---------| - |AZURE_SUBSCRIPTION_ID | Subscription ID | - |AZURE_TENANT_ID | Directory (tenant) ID | - - > [!NOTE] - > For security reasons, we recommend using GitHub Secrets rather than passing values directly to the workflow. - -### Set up Azure Login action with system-assigned managed identity in GitHub Actions workflows - -In this example, you use the system-assigned managed identity to authenticate with Azure with the [Azure login](https://github.com/marketplace/actions/azure-login) action. The example uses GitHub secrets for the `subscription-id`, and `tenant-id` values. The self-hosted runner has been labeled `self-hosted` on GitHub. - - -```yaml -name: Run Azure Login with system-assigned managed identity -on: [push] - -jobs: - test: - runs-on: [self-hosted] # Specify the label of your self-hosted runner here - steps: - - name: Azure login - uses: azure/login@v2 - with: - auth-type: IDENTITY - tenant-id: ${{ secrets.AZURE_TENANT_ID }} - subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} - enable-AzPSSession: true - - # Azure CLI action only supports linux self-hosted runners for now. - # If you want to execute the Azure CLI script on a windows self-hosted runner, you can execute it directly in `run`. - - name: Azure CLI script - uses: azure/cli@v2 - with: - azcliversion: latest - inlineScript: | - az account show - # You can write your Azure CLI inline scripts here. - - - name: Azure PowerShell script - uses: azure/powershell@v2 - with: - azPSVersion: latest - inlineScript: | - Get-AzContext - # You can write your Azure PowerShell inline scripts here. -``` - -## Use the Azure Login action with user-assigned managed identity - -Learn how to securely authenticate to Azure services from GitHub Actions workflows using [Azure Login action](https://github.com/marketplace/actions/azure-login) with [user-assigned managed identity](/entra/identity/managed-identities-azure-resources/how-to-configure-managed-identities#user-assigned-managed-identity) that configured on a virtual machine. - -### Create GitHub secrets for user-assigned managed identity - -1. Open your GitHub repository and go to **Settings**. - :::image type="content" source="media/github-repo-settings.png" alt-text="Select settings tab in GitHub repository."::: - - -1. Select **Security > Secrets and variables > Actions > New repository secret**. - :::image type="content" source="media/github-repo-secrets.png" alt-text="Select Security > Secrets and variables > Actions."::: - - > [!NOTE] - > To enhance workflow security in public repositories, use [environment secrets](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets) instead of repository secrets. If the environment requires approval, a job cannot access environment secrets until one of the required reviewers approves it. - -1. Create secrets for `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, and `AZURE_SUBSCRIPTION_ID`. Copy these values from your user-assigned managed identity for your GitHub secrets: - - |GitHub secret |User-assigned managed identity | - |---------|---------| - |AZURE_CLIENT_ID | Client ID | - |AZURE_SUBSCRIPTION_ID | Subscription ID | - |AZURE_TENANT_ID | Directory (tenant) ID | - - > [!NOTE] - > For security reasons, we recommend using GitHub Secrets rather than passing values directly to the workflow. - -### Set up Azure Login action with user-assigned managed identity in GitHub Actions workflows - -In this example, you use the user-assigned managed identity to authenticate with Azure with the [Azure login](https://github.com/marketplace/actions/azure-login) action. The example uses GitHub secrets for the `client-id`, `subscription-id`, and `tenant-id` values. The self-hosted runner has been labeled `self-hosted` on GitHub. - -```yaml -name: Run Azure Login with user-assigned managed identity -on: [push] - -jobs: - test: - runs-on: [self-hosted] # Specify the label of your self-hosted runner here - steps: - - name: Azure login - uses: azure/login@v2 - with: - auth-type: IDENTITY - client-id: ${{ secrets.AZURE_CLIENT_ID }} - tenant-id: ${{ secrets.AZURE_TENANT_ID }} - subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} - enable-AzPSSession: true - - # Azure CLI action only supports linux self-hosted runners for now. - # If you want to execute the Azure CLI script on a windows self-hosted runner, you can execute it directly in `run`. - - name: Azure CLI script - uses: azure/cli@v2 - with: - azcliversion: latest - inlineScript: | - az account show - # You can write your Azure CLI inline scripts here. - - - name: Azure PowerShell script - uses: azure/powershell@v2 - with: - azPSVersion: latest - inlineScript: | - Get-AzContext - # You can write your Azure PowerShell inline scripts here. -``` \ No newline at end of file diff --git a/articles/github/connect-from-azure-openid-connect.md b/articles/github/connect-from-azure-openid-connect.md deleted file mode 100644 index 8dda9f0af6..0000000000 --- a/articles/github/connect-from-azure-openid-connect.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: Authenticate to Azure from GitHub Actions by OpenID Connect -description: Securely authenticate to Azure services from GitHub Actions workflows using Azure Login action with OpenID Connect (OIDC). -author: MoChilia -ms.author: shiyingchen -ms.topic: reference -ms.service: azure -ms.date: 07/01/2024 -ms.custom: github-actions-azure, devx-track-azurecli, devx-track-azurepowershell, linux-related-content ---- - -# Use the Azure Login action with OpenID Connect - -Learn how to securely authenticate to Azure services from GitHub Actions workflows using [Azure Login action](https://github.com/marketplace/actions/azure-login) with [OpenID Connect (OIDC)](https://www.microsoft.com/security/business/security-101/what-is-openid-connect-oidc). - -In this tutorial, you learn how to: - -> [!div class="checklist"] -> * Create GitHub secrets for the credentials of a Microsoft Entra application/user-assigned managed identity -> * Set up Azure Login with OpenID Connect authentication in GitHub Actions workflows - -## Prerequisites - -To use [Azure Login action](https://github.com/marketplace/actions/azure-login) with OIDC, you need to configure a federated identity credential on a Microsoft Entra application or a user-assigned managed identity. - -**Option 1: Microsoft Entra application** - -* Create a Microsoft Entra application with a service principal by [Azure portal](/entra/identity-platform/howto-create-service-principal-portal#register-an-application-with-microsoft-entra-id-and-create-a-service-principal), [Azure CLI](/cli/azure/azure-cli-sp-tutorial-1#create-a-service-principal), or [Azure PowerShell](/powershell/azure/create-azure-service-principal-azureps#create-a-service-principal). -* Copy the values for **Client ID**, **Subscription ID**, and **Directory (tenant) ID** to use later in your GitHub Actions workflow. -* Assign an appropriate role to your service principal by [Azure portal](/entra/identity-platform/howto-create-service-principal-portal#assign-a-role-to-the-application), [Azure CLI](/cli/azure/azure-cli-sp-tutorial-5#create-or-remove-a-role-assignment), or [Azure PowerShell](/powershell/azure/create-azure-service-principal-azureps#manage-service-principal-roles). -* [Configure a federated identity credential on a Microsoft Entra application](/entra/workload-id/workload-identity-federation-create-trust) to trust tokens issued by GitHub Actions to your GitHub repository. - -**Option 2: User-assigned managed identity** - -* [Create a user-assigned managed identity](/entra/identity/managed-identities-azure-resources/how-manage-user-assigned-managed-identities#create-a-user-assigned-managed-identity). -* Copy the values for **Client ID**, **Subscription ID**, and **Directory (tenant) ID** to use later in your GitHub Actions workflow. -* [Assign an appropriate role to your user-assigned managed identity](/entra/identity/managed-identities-azure-resources/how-manage-user-assigned-managed-identities#manage-access-to-user-assigned-managed-identities). -* [Configure a federated identity credential on a user-assigned managed identity](/entra/workload-id/workload-identity-federation-create-trust-user-assigned-managed-identity) to trust tokens issued by GitHub Actions to your GitHub repository. - -## Create GitHub secrets - -1. Open your GitHub repository and go to **Settings**. - :::image type="content" source="media/github-repo-settings.png" alt-text="Select settings tab in GitHub repository."::: - -1. Select **Security > Secrets and variables > Actions > New repository secret**. - :::image type="content" source="media/github-repo-secrets.png" alt-text="Select Security > Secrets and variables > Actions."::: - - > [!NOTE] - > To enhance workflow security in public repositories, use [environment secrets](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets) instead of repository secrets. If the environment requires approval, a job cannot access environment secrets until one of the required reviewers approves it. - -1. Create secrets for `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, and `AZURE_SUBSCRIPTION_ID`. Copy these values from your Microsoft Entra application or user-assigned managed identity for your GitHub secrets: - - |GitHub secret |Microsoft Entra application or user-assigned managed identity | - |---------|---------| - |AZURE_CLIENT_ID | Client ID | - |AZURE_SUBSCRIPTION_ID | Subscription ID | - |AZURE_TENANT_ID | Directory (tenant) ID | - - > [!NOTE] - > For security reasons, we recommend using GitHub Secrets rather than passing values directly to the workflow. - -## Set up Azure Login action with OpenID Connect in GitHub Actions workflows - -Your GitHub Actions workflow uses OpenID Connect to authenticate with Azure. Once you have a working Azure Login step, you can use the [Azure PowerShell action](https://github.com/Azure/PowerShell) or [Azure CLI action](https://github.com/Azure/CLI). You can also use other Azure actions, like [Azure webapp deploy](https://github.com/Azure/webapps-deploy) and [Azure functions](https://github.com/Azure/functions-action). - -To learn more about this interaction, see the [GitHub Actions documentation](https://docs.github.com/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure). - -In this example, you use OpenID Connect to authenticate with Azure with the [Azure login](https://github.com/marketplace/actions/azure-login) action. The example uses GitHub secrets stored before for the `client-id`, `tenant-id`, and `subscription-id` values. - -The Azure Login action includes an optional `audience` input parameter that defaults to `api://AzureADTokenExchange`, available for public clouds. For non-public clouds, update this parameter with the appropriate values. You can also customize this parameter for specific audience values. - -### The workflow sample to only run Azure CLI - -This workflow authenticates with OpenID Connect and uses Azure CLI to get the details of the connected subscription. - -```yaml -name: Run Azure CLI Login with OpenID Connect -on: [push] - -jobs: - test: - permissions: - id-token: write # Require write permission to Fetch an OIDC token. - - runs-on: ubuntu-latest - steps: - - name: Azure CLI Login - uses: azure/login@v2 - with: - client-id: ${{ secrets.AZURE_CLIENT_ID }} - tenant-id: ${{ secrets.AZURE_TENANT_ID }} - subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} - - - name: Azure CLI script - uses: azure/cli@v2 - with: - azcliversion: latest - inlineScript: | - az account show - # You can write your Azure CLI inline scripts here. -``` - -### The workflow sample to run both Azure CLI and Azure PowerShell - -This workflow authenticates with OpenID Connect and uses both Azure CLI and Azure PowerShell to get the details of the connected subscription. - -```yaml -name: Run Azure Login with OpenID Connect -on: [push] - -jobs: - test: - permissions: - id-token: write # Require write permission to Fetch an OIDC token. - - runs-on: ubuntu-latest - steps: - - name: Azure Login - uses: azure/login@v2 - with: - client-id: ${{ secrets.AZURE_CLIENT_ID }} - tenant-id: ${{ secrets.AZURE_TENANT_ID }} - subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} - enable-AzPSSession: true - - - name: Azure CLI script - uses: azure/cli@v2 - with: - azcliversion: latest - inlineScript: | - az account show - # You can write your Azure CLI inline scripts here. - - - name: Azure PowerShell script - uses: azure/powershell@v2 - with: - azPSVersion: latest - inlineScript: | - Get-AzContext - # You can write your Azure PowerShell inline scripts here. -``` - - -### Connect to Azure Government clouds and Azure Stack Hub clouds - -To log in to one of the Azure Government clouds or Azure Stack, set the parameter `environment` to one of the following supported values: `AzureUSGovernment`, `AzureChinaCloud`, `AzureGermanCloud`, or `AzureStack`. If this parameter isn't specified, it takes the default value `AzureCloud` and connects to the Azure Public Cloud. - -```yaml -jobs: - test: - permissions: - id-token: write # Require write permission to Fetch an OIDC token. - runs-on: ubuntu-latest - steps: - - name: Login to Azure US Gov Cloud with both Azure CLI and Azure Powershell - uses: azure/login@v2 - with: - client-id: ${{ secrets.AZURE_CLIENT_ID }} - tenant-id: ${{ secrets.AZURE_TENANT_ID }} - subscription-id: ${{ secrets.AZURE_SUBSCRIPTION_ID }} - environment: 'AzureUSGovernment' - audience: api://AzureADTokenExchangeUSGov - enable-AzPSSession: true -``` diff --git a/articles/github/connect-from-azure-secret.md b/articles/github/connect-from-azure-secret.md deleted file mode 100644 index 6882ab5d91..0000000000 --- a/articles/github/connect-from-azure-secret.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Authenticate to Azure from GitHub Actions by a secret -description: Securely authenticate to Azure services from GitHub Actions workflows using Azure Login action with a client secret. -author: MoChilia -ms.author: shiyingchen -ms.topic: reference -ms.service: azure -ms.date: 07/01/2024 -ms.custom: github-actions-azure, devx-track-azurecli, devx-track-azurepowershell, linux-related-content ---- - -# Use the Azure Login action with a client secret - -Learn how to create a service principal with a client secret and securely authenticate to Azure services from GitHub Actions workflows using [Azure Login action](https://github.com/marketplace/actions/azure-login). - -In this tutorial, you learn how to: - -> [!div class="checklist"] -> * Create a GitHub secret for the service principal -> * Set up Azure Login for service principal secret in GitHub Actions workflows - -> [!WARNING] -> Treat your client secrets with care to prevent leaks. Unauthorized disclosure can compromise security. Store secrets securely and share only with authorized ones. - -## Prerequisites - -- Create a Microsoft Entra application with a service principal by [Azure portal](/entra/identity-platform/howto-create-service-principal-portal#register-an-application-with-microsoft-entra-id-and-create-a-service-principal), [Azure CLI](/cli/azure/azure-cli-sp-tutorial-1#create-a-service-principal), or [Azure PowerShell](/powershell/azure/create-azure-service-principal-azureps#create-a-service-principal). -- Create a client secret for your service principal by [Azure portal](/entra/identity-platform/howto-create-service-principal-portal#option-3-create-a-new-client-secret), [Azure CLI](/cli/azure/azure-cli-sp-tutorial-2?branch=main#create-a-service-principal-containing-a-password), or [Azure PowerShell](/powershell/azure/create-azure-service-principal-azureps?#password-based-authentication). -- Copy the values for **Client ID**, **Client Secret**, **Subscription ID**, and **Directory (tenant) ID** to use later in your GitHub Actions workflow. -- Assign an appropriate role to your service principal by [Azure portal](/entra/identity-platform/howto-create-service-principal-portal#assign-a-role-to-the-application), [Azure CLI](/cli/azure/azure-cli-sp-tutorial-5#create-or-remove-a-role-assignment), or [Azure PowerShell](/powershell/azure/create-azure-service-principal-azureps#manage-service-principal-roles). - -## Create a GitHub secret for the service principal - -1. Open your GitHub repository and go to **Settings**. - :::image type="content" source="media/github-repo-settings.png" alt-text="Select settings tab in GitHub repository."::: - -1. Select **Security > Secrets and variables > Actions > New repository secret**. - :::image type="content" source="media/github-repo-secrets.png" alt-text="Select Security > Secrets and variables > Actions."::: - - > [!NOTE] - > To enhance workflow security in public repositories, use [environment secrets](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets) instead of repository secrets. If the environment requires approval, a job cannot access environment secrets until one of the required reviewers approves it. - -1. Create a GitHub Actions secret `AZURE_CREDENTIALS` in the following format. Copy these values from your service principal. - - ```json - { - "clientId": "", - "clientSecret": "", - "subscriptionId": "", - "tenantId": "" - } - ``` - - |GitHub secret |Service principal | - |---------|---------| - |clientId | Client ID | - |clientSecret | Client Secret | - |subscriptionId | Subscription ID | - |tenantId | Directory (tenant) ID | - -## Set up Azure Login action with the Service Principal secret in GitHub Actions workflows - -To authenticate to Azure in GitHub Actions workflows using the service principal secret, you need to use the [Azure Login action](https://github.com/Azure/login). - -### Use the Azure Login action with both Azure CLI action and Azure PowerShell action - -In this workflow, you authenticate using the Azure Login action with the service principal details stored in `secrets.AZURE_CREDENTIALS`. For more information about referencing GitHub secrets in a workflow file, see [Using secrets in a workflow](https://docs.github.com/actions/security-guides/using-secrets-in-github-actions#using-secrets-in-a-workflow) in GitHub Docs. - -```yaml -name: Run Azure Login with the Service Principal secret -on: [push] - -jobs: - test: - runs-on: ubuntu-latest - steps: - - name: Azure Login action - uses: azure/login@v2 - with: - creds: ${{ secrets.AZURE_CREDENTIALS }} - enable-AzPSSession: true - - - name: Azure CLI script - uses: azure/cli@v2 - with: - azcliversion: latest - inlineScript: | - az group show --name "" - # You can write your Azure CLI inline scripts here. - - - name: Azure PowerShell action - uses: azure/powershell@v2 - with: - azPSVersion: latest - inlineScript: | - Get-AzResourceGroup -Name "" - # You can write your Azure PowerShell inline scripts here. -``` \ No newline at end of file diff --git a/articles/github/connect-from-azure.md b/articles/github/connect-from-azure.md deleted file mode 100644 index d7009e5f2d..0000000000 --- a/articles/github/connect-from-azure.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Authenticate to Azure from GitHub Actions workflows -description: Securely authenticate to Azure services from GitHub Actions workflows using Azure Login action and manage your Azure resources. -author: MoChilia -ms.author: shiyingchen -ms.topic: reference -ms.service: azure -ms.date: 07/01/2024 -ms.custom: github-actions-azure, devx-track-azurecli, devx-track-azurepowershell, linux-related-content ---- - -# Use GitHub Actions to connect to Azure - -Learn how to use [Azure Login action](https://github.com/Azure/login) with either [Azure PowerShell action](https://github.com/Azure/PowerShell) or [Azure CLI action](https://github.com/Azure/CLI) to interact with your Azure resources. - -To use Azure PowerShell or Azure CLI in a GitHub Actions workflow, you need to first log in with the [Azure Login action](https://github.com/marketplace/actions/azure-login) action. - -The Azure Login action supports different ways of authenticating with Azure: - -* [Sign in with OpenID Connect using a Microsoft Entra application or a user-assigned managed identity](connect-from-azure-openid-connect.md) -* [Sign in with a managed identity configured on an Azure virtual machine](connect-from-azure-identity.md) (Only available for self-hosted GitHub runners) -* [Sign in with a service principal and secret](connect-from-azure-secret.md) (Not recommended) - -By default, the Azure Login action logs in with the Azure CLI and sets up the GitHub Actions runner environment for Azure CLI. You can use Azure PowerShell with `enable-AzPSSession` property of the Azure Login action. This property sets up the GitHub Actions runner environment with the Azure PowerShell module. - -You can also use the Azure Login action to connect to public or sovereign clouds including Azure Government and Azure Stack Hub. - -## Connect with other Azure services - -The following articles provide details on connecting from GitHub to Azure and other services. - -| Service | Tutorial | -|-|-| -| Microsoft Entra ID | [Sign in to GitHub Enterprise with Microsoft Entra ID (single sign-on)](/azure/active-directory/saas-apps/github-tutorial) -| Power BI | [Connect Power BI with GitHub](/power-bi/service-connect-to-github) -| GitHub Connectors | [GitHub connector for Azure Logic Apps, Power Automate, and Power Apps](/connectors/github/) -| Azure Databricks | [Use GitHub as version control for notebooks](/azure/databricks/notebooks/github-version-control) - -> [!div class="nextstepaction"] -> [Deploy apps from GitHub to Azure](deploy-to-azure.md) diff --git a/articles/github/database-actions-deploy.md b/articles/github/database-actions-deploy.md deleted file mode 100644 index 4de567c9f7..0000000000 --- a/articles/github/database-actions-deploy.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Deploy databases from GitHub to Azure -description: Support to deploy databases from GitHub to Azure -author: juliakm -ms.author: jukullam -ms.topic: reference -ms.service: azure -ms.date: 02/15/2023 -ms.custom: github-actions-azure ---- - -# Deploy databases from GitHub to Azure - -The following articles provide support to deploy database updates from GitHub to Azure. You can use GitHub Actions to deploy to [Azure SQL](/azure/azure-sql/), [Azure MySQL](/azure/mysql/), and [Azure Database for PostgreSQL](/azure/postgresql/). - -For Azure SQL Managed Instance, [use Azure CLI](/cli/azure/sql/) and the [Azure CLI action](https://github.com/marketplace/actions/azure-cli-action). - -- [Use GitHub Actions to connect to Azure SQL Database](/azure/azure-sql/database/connect-github-actions-sql-db) -- [Use GitHub Actions to connect to Azure MySQL](/azure/mysql/quickstart-mysql-github-actions) -- [Use GitHub Actions to connect to Azure PostgreSQL](/azure/postgresql/how-to-deploy-github-action) diff --git a/articles/github/deploy-to-azure.md b/articles/github/deploy-to-azure.md deleted file mode 100644 index 5ed7ac8526..0000000000 --- a/articles/github/deploy-to-azure.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Deploy apps from GitHub to Azure -description: Support to deploy apps from GitHub to Azure -author: N-Usha -ms.author: ushan -ms.topic: reference -ms.service: azure -ms.date: 09/24/2021 -ms.custom: github-actions-azure, devx-track-arm-template ---- - - -# Deploy apps from GitHub to Azure - -The following articles provide support to deploy apps from GitHub to Azure. - -## Azure App Service - -- [Deploy to Azure App Service on Linux using GitHub Actions](/azure/app-service/deploy-github-actions) -- [Deploy an Azure App Service Custom Container with GitHub Actions](/azure/app-service/deploy-container-github-action) -- [Deploy to App Service on Linux and connect to a database](/azure/app-service/app-service-sql-asp-github-actions) -- [Deploy to Azure App Service on Linux using Visual Studio Code](/azure/devops/pipelines/targets/deploy-to-azure-vscode) -- [Tutorial: Use GitHub Actions to deploy to an App Service Custom Container and connect to a database](/azure/app-service/app-service-sql-github-actions) - -## Azure Functions - -- [Deploy a function app continuously from GitHub](/azure/azure-functions/scripts/functions-cli-create-function-app-github-continuous) -- [Deploy to Azure Functions using GitHub Actions](/azure/azure-functions/functions-how-to-github-actions) - -## Azure App Configuration - -- [Sync your GitHub repository to App Configuration](/azure/azure-app-configuration/push-kv-github-action) - -## Azure Storage - -- [Use GitHub Actions workflow to deploy your static website in Azure Storage](/azure/storage/blobs/storage-blobs-static-site-github-actions) -## Azure Container Instances - -- [Configure a GitHub action to create a container instance](/azure/container-instances/container-instances-github-action) - -## Azure Kubernetes Service - -- [Use GitHub Actions to deploy to Kubernetes](/azure/aks/kubernetes-action) -- [Deploy to Azure Dev Spaces using GitHub Actions](/azure/dev-spaces/how-to/github-actions) - -## Azure Shared Image Gallery -- [Build custom virtual machine images with GitHub Actions](build-vm-image.md) - -## Azure Pipelines - -- [Trigger a Pipeline run from GitHub Actions](/azure/devops/pipelines/ecosystems/github-actions) - - -## Azure Resource Manager templates - -- [Deploy Bicep files by using GitHub Actions](/azure/azure-resource-manager/bicep/deploy-github-actions) -- [Deploy Azure Resource Manager templates by using GitHub Actions](/azure/azure-resource-manager/templates/deploy-github-actions) - -## Azure Machine Learning - -- [Use GitHub Actions with Azure Machine Learning](/azure/machine-learning/how-to-github-actions-machine-learning) - -## Azure Stack - -- [Use the Azure login action with Azure CLI and PowerShell on Azure Stack Hub](/azure-stack/user/ci-cd-github-action-login-cli) diff --git a/articles/github/deploy-with-visual-studio.md b/articles/github/deploy-with-visual-studio.md deleted file mode 100644 index da7cce5baf..0000000000 --- a/articles/github/deploy-with-visual-studio.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Use Visual Studio to deploy apps from GitHub -description: Visual Studio and Visual Studio Code resources to deploy apps from GitHub -author: N-Usha -ms.author: ushan -ms.topic: reference -ms.service: azure -ms.date: 05/05/2020 ---- - - -# Use Visual Studio or Visual Studio Code to deploy apps from GitHub - -Review the following article to learn how to use Visual Studio or Visual Studio Code with GitHub. - -- [Deploy to Azure App Service using Visual Studio Code](/azure/devops/pipelines/targets/deploy-to-azure-vscode) -- [Visual Studio subscription with GitHub offer](/visualstudio/subscriptions/access-github) - -And, the following Marketplace extensions provide developer support for integrating with GitHub. - -- [GitHub extension for Visual Studio](https://visualstudio.github.com/) -- [GitHub extension for Visual Studio Code](https://vscode.github.com/) - -You can also use Visual Studio and Visual Studio Code to create your own actions. - -- [Tutorial: Create a GitHub Action with .NET](/dotnet/devops/create-dotnet-github-action) diff --git a/articles/github/github-actions.md b/articles/github/github-actions.md deleted file mode 100644 index a95963eb03..0000000000 --- a/articles/github/github-actions.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: What is GitHub Actions for Azure? -description: Create workflows within your repository to build, test, package, release, and deploy to Azure. -author: N-Usha -ms.author: ushan -ms.topic: conceptual -ms.service: azure -ms.date: 03/19/2022 -ms.custom: github-actions-azure ---- - - -# What is GitHub Actions for Azure - -[GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions) helps you automate your software development workflows from within GitHub. You can deploy workflows in the same place where you store code and collaborate on pull requests and issues. - -In GitHub Actions, a [workflow](https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/introduction-to-github-actions) is an automated process that you set up in your GitHub repository. You can build, test, package, release, or deploy any project on GitHub with a workflow. - -Each workflow is made up of individual [actions](https://docs.github.com/en/actions/learn-github-actions/introduction-to-github-actions) that run after a specific event (like a pull request) occur. The individual actions are packaged scripts that automate software development tasks. - -With GitHub Actions for Azure, you can create workflows that you can set up in your repository to build, test, package, release, and deploy to Azure. GitHub Actions for Azure supports Azure services, including Azure App Service, Azure Functions, and Azure Key Vault. - -GitHub Actions also include support for utilities, including Azure Resource Manager templates, Azure CLI, and Azure Policy. - -Watch this video from GitHub Universe 2020 to learn more about continuous delivery with GitHub Actions. - -> [!VIDEO https://www.youtube.com/embed/36hY0-O4STg] - -## Why should I use GitHub Actions for Azure - -Microsoft developed GitHub Actions for Azure and designed them be used with Azure. You can see all of the GitHub Actions for Azure in the [GitHub Marketplace](https://github.com/marketplace?query=Azure&type=actions). See [Finding and customizing actions](https://docs.github.com/en/actions/learn-github-actions/finding-and-customizing-actions) to learn more about incorporating actions into your workflows. - -## What is the difference between GitHub Actions and Azure Pipelines - -Azure Pipelines and GitHub Actions both help you automate software development workflows. [Learn more](https://docs.github.com/en/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions) about how the services differ and how to migrate from Azure Pipelines to GitHub Actions. - -## What do I need to use GitHub Actions for Azure - -You'll need Azure and GitHub accounts: - -* An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F). -* A GitHub account. If you don't have one, sign up for [free](https://github.com/join). - -## How do I connect GitHub Actions and Azure - -Depending on the action, you can use service principal or publish profile to connect to Azure from GitHub. You'll use a service principal each time you use the [Azure login](https://github.com/marketplace/actions/azure-login) action. When you use a service principal you can use OpenID Connect or a secret. - -The [Azure App Service action](https://github.com/marketplace/actions/azure-webapp) supports using a publish profile or service principal. See [Application and service principal objects in Microsoft Entra ID](/azure/active-directory/develop/app-objects-and-service-principals#service-principal-object) to learn more about service principals. - -You can use the Azure login action in combination with both the [Azure CLI](https://github.com/marketplace/actions/azure-cli-action) and Azure [Azure PowerShell](https://github.com/marketplace/actions/azure-powershell-action) actions. The Azure login action also works with most other GitHub actions for Azure including [deploying to web apps](https://github.com/marketplace/actions/azure-webapp). You can also use Azure login with community-contributed actions like [Enhanced Azure key vault](https://github.com/marketplace/actions/enhanced-env-azure-key-vault-get-secrets) that aren't officially supported by Microsoft. - -## What is included in a GitHub Actions workflow - -Workflows are made up of one or more jobs. Within a job, there are steps made up of individual actions. See [Introduction to GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/introduction-to-github-actions) to learn more about GitHub Actions concepts. - -## Where can I see complete workflow examples - -The [Azure starter action workflows repository](https://github.com/Azure/actions-workflow-samples) includes end-to-end workflows to build and deploy Web apps of any language, any ecosystem to Azure. - -## Where can I see all the available actions - -Visit the [Marketplace for GitHub Actions for Azure](https://github.com/marketplace?query=Azure&type=actions) to see all the available GitHub Actions for Azure. - -* [Azure Spring Cloud](https://github.com/Azure/azure-spring-cloud) -* [Deploy Bicep file or Azure Resource Manager template](https://github.com/Azure/arm-deploy) -* [Deploy to a static web app](/azure/static-web-apps/getting-started?tabs=angular) -* [Azure App Service settings](https://github.com/Azure/appservice-settings) -* [Deploy to Azure Functions](https://github.com/Azure/functions-action) -* [Deploy to Azure Functions for Containers](https://github.com/Azure/webapps-container-deploy) -* [Docker login](https://github.com/Azure/docker-login) -* [Deploy to Azure Container Instances](https://github.com/Azure/aci-deploy) -* [Container scanning action](https://github.com/Azure/container-scan) -* [Kubectl tool installer](https://github.com/Azure/setup-kubectl) -* [Kubernetes set context](https://github.com/Azure/k8s-set-context) -* [AKS set context](https://github.com/Azure/aks-set-context) -* [Kubernetes create secret](https://github.com/Azure/k8s-create-secret) -* [Kubernetes deploy](https://github.com/Azure/k8s-deploy) -* [Setup Helm](https://github.com/Azure/setup-helm) -* [Kubernetes bake](https://github.com/Azure/k8s-bake) -* [Build Azure virtual machine images](https://github.com/Azure/build-vm-image) -* [Machine learning login](https://github.com/Azure/aml-workspace) -* [Machine learning training](https://github.com/Azure/aml-run) -* [Machine learning - deploy model](https://github.com/Azure/aml-deploy) -* [Deploy to Azure SQL database](https://github.com/Azure/sql-action) -* [Deploy to Azure MySQL action](https://github.com/Azure/mysql-action) -* [Azure Policy Compliance Scan](https://github.com/Azure/policy-compliance-scan) -* [Manage Azure Policy](https://github.com/Azure/manage-azure-policy) -* [Trigger an Azure Pipelines run](https://github.com/Azure/pipelines) - diff --git a/articles/github/index.yml b/articles/github/index.yml deleted file mode 100644 index bb9d739ea4..0000000000 --- a/articles/github/index.yml +++ /dev/null @@ -1,82 +0,0 @@ -### YamlMime:Landing - -title: Azure and GitHub integration -summary: Learn how GitHub and Azure work together to let you build and deploy apps. - -metadata: - title: Azure and GitHub integration - description: Learn how GitHub and Azure work together to let you build and deploy apps. - ms.service: azure - ms.topic: landing-page - author: N-Usha - ms.author: ushan - ms.date: 11/24/2020 - ms.custom: github-actions-azure - -# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new - -landingContent: -# Cards and links should be based on top customer tasks or top subjects -# Start card title with a verb - # Card (optional) - - title: GitHub Actions for Azure - linkLists: - - linkListType: get-started - links: - - text: What is GitHub Actions for Azure? - url: github-actions.md - # Card (optional) - - title: Deploy to Azure - linkLists: - - linkListType: deploy - links: - - text: Deploy apps from GitHub to Azure - url: deploy-to-azure.md - - text: Deploy databases from GitHub to Azure - url: database-actions-deploy.md - - text: Build custom virtual images - url: build-vm-image.md - - # Card - - title: Tools for interacting with GitHub Actions - linkLists: - - linkListType: get-started - links: - - text: Authenticate from Azure to GitHub - url: connect-from-azure.md - - # Card (optional) - - title: Azure Developer CLI (azd) - linkLists: - - linkListType: deploy - links: - - text: What is Azure Developer CLI? - url: ../azure-developer-cli/overview.md - - text: Get started - url: ../azure-developer-cli/install-azd.md - - text: See more in the Azure Developer CLI developer center - url: ../azure-developer-cli/index.yml - - # Card (optional) - # - title: Visual Studio and Visual Studio Code - # linkLists: - # - linkListType: deploy - # links: - # - text: Use Visual Studio or Visual Studio Code to deploy apps from GitHub - # url: deploy-with-visual-studio.md - - # Card (optional) - - title: Azure Pipelines and GitHub integration - linkLists: - - linkListType: how-to-guide - links: - - text: Work with Azure DevOps and GitHub - url: integrate-azure-devops.md - - # Card (optional) - - title: Manage Azure Policies with GitHub - linkLists: - - linkListType: get-started - links: - - text: Manage Azure Policies as code with GitHub - url: manage-azure-policy.md diff --git a/articles/github/integrate-azure-devops.md b/articles/github/integrate-azure-devops.md deleted file mode 100644 index 9e9a152be3..0000000000 --- a/articles/github/integrate-azure-devops.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Work with Azure DevOps and GitHub -description: Find resources that support integration of Azure DevOps and GitHub -author: N-Usha -ms.author: ushan -ms.topic: reference -ms.service: azure -ms.date: 05/05/2020 -ms.custom: github-actions-azure ---- - - -# Work with Azure DevOps and GitHub - -Review the following article to learn how Azure DevOps works with GitHub. - -- [Connect Azure Boards with GitHub](/azure/devops/boards/github) -- [Link Azure Boards work items to GitHub commits, pull requests and issues](/azure/devops/boards/github/link-to-from-github) -- [Use Azure Pipelines to build GitHub repositories](/azure/devops/pipelines/repos/github) -- [Create a GitHub Release from Azure Pipelines](/azure/devops/pipelines/tasks/utility/github-release) - diff --git a/articles/github/manage-azure-policy.md b/articles/github/manage-azure-policy.md deleted file mode 100644 index 37787923d2..0000000000 --- a/articles/github/manage-azure-policy.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Manage Azure Policies with GitHub -description: Manage Azure Policies as code from GitHub -author: raiyanalam -ms.custom: github-actions-azure -ms.author: moala -ms.topic: reference -ms.service: azure-policy -ms.date: 10/27/2020 ---- - - -# Manage Azure Policies with GitHub - -Review the following articles to learn how to manage Azure Policies as code from GitHub - -- [Export Azure Policies from Azure](/azure/governance/policy/how-to/export-resources) -- [Manage Azure Policies as code from GitHub](/azure/governance/policy/tutorials/policy-as-code-github) -- [Trigger Azure compliance scans](/azure/governance/policy/how-to/get-compliance-data#on-demand-evaluation-scan) \ No newline at end of file diff --git a/articles/github/media/github-repo-secrets.png b/articles/github/media/github-repo-secrets.png deleted file mode 100644 index 2ef7d9f574..0000000000 Binary files a/articles/github/media/github-repo-secrets.png and /dev/null differ diff --git a/articles/github/media/github-repo-settings.png b/articles/github/media/github-repo-settings.png deleted file mode 100644 index 51987a9006..0000000000 Binary files a/articles/github/media/github-repo-settings.png and /dev/null differ diff --git a/articles/github/toc.yml b/articles/github/toc.yml deleted file mode 100644 index 7b41742e74..0000000000 --- a/articles/github/toc.yml +++ /dev/null @@ -1,31 +0,0 @@ -- name: Azure and GitHub integration - href: index.yml - items: - - name: GitHub Actions for Azure - expanded: true - items: - - name: Introduction to GitHub Actions for Azure - href: github-actions.md - - name: Authenticate to Azure from GitHub - expanded: true - items: - - name: Authenticatication methods - href: connect-from-azure.md - - name: Sign in with OpenID Connect - href: connect-from-azure-openid-connect.md - - name: Sign in with a managed identity configured on an Azure VM - href: connect-from-azure-identity.md - - name: Sign in with a service principal and secret - href: connect-from-azure-secret.md - - name: Deploy apps to Azure - href: deploy-to-azure.md - - name: Deploy databases to Azure - href: database-actions-deploy.md - - name: Manage Azure Policy - href: manage-azure-policy.md - - name: Build custom virtual machine images - href: build-vm-image.md - - name: Azure DevOps & GitHub - href: integrate-azure-devops.md - - name: Visual Studio and Visual Studio Code - href: deploy-with-visual-studio.md \ No newline at end of file