mirror of
https://github.com/azure/login.git
synced 2026-03-15 09:20:56 -04:00
Update README.md (#26)
This commit is contained in:
51
README.md
51
README.md
@@ -7,7 +7,9 @@
|
|||||||
With [GitHub Actions for Azure](https://github.com/Azure/actions/) you can create workflows that you can set up in your repository to build, test, package, release and **deploy** to Azure.
|
With [GitHub Actions for Azure](https://github.com/Azure/actions/) you can create workflows that you can set up in your repository to build, test, package, release and **deploy** to Azure.
|
||||||
|
|
||||||
# GitHub Action for Azure Login
|
# GitHub Action for Azure Login
|
||||||
With the Azure login Action, you can automate your workflow to do an Azure login using [Azure service principal](https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals) and run Az CLI scripts.
|
With the Azure login Action, you can automate your workflow to do an Azure login using [Azure service principal](https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals) and run Az CLI and Azure PowerShell scripts.
|
||||||
|
|
||||||
|
By default, only az cli login will be done. In addition to az cli, you can login using Az module to run Azure PowerShell scripts by setting enable-AzPSSession to true.
|
||||||
|
|
||||||
Get started today with a [free Azure account](https://azure.com/free/open-source)!
|
Get started today with a [free Azure account](https://azure.com/free/open-source)!
|
||||||
|
|
||||||
@@ -38,6 +40,35 @@ jobs:
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Sample workflow that uses Azure login action to run Azure PowerShell
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
|
||||||
|
# File: .github/workflows/workflow.yml
|
||||||
|
|
||||||
|
on: [push]
|
||||||
|
|
||||||
|
name: AzurePowerShellLoginSample
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
|
||||||
|
- name: Login via Az module
|
||||||
|
uses: azure/login@v1.1
|
||||||
|
with:
|
||||||
|
creds: ${{secrets.AZURE_CREDENTIALS}}
|
||||||
|
enable-AzPSSession: true
|
||||||
|
|
||||||
|
- run: |
|
||||||
|
Get-AzVM -ResourceGroupName "ResourceGroup11"
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Refer [Azure PowerShell](https://github.com/azure/powershell) Github action to run your Azure PowerShell scripts.
|
||||||
|
|
||||||
## Configure deployment credentials:
|
## Configure deployment credentials:
|
||||||
|
|
||||||
For any credentials like Azure Service Principal, Publish Profile etc add them as [secrets](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) in the GitHub repository and then use them in the workflow.
|
For any credentials like Azure Service Principal, Publish Profile etc add them as [secrets](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) in the GitHub repository and then use them in the workflow.
|
||||||
@@ -76,18 +107,22 @@ Follow the steps to configure the secret:
|
|||||||
# action.yml
|
# action.yml
|
||||||
|
|
||||||
# Login to Azure subscription
|
# Login to Azure subscription
|
||||||
name: 'Login Azure'
|
name: 'Azure Login'
|
||||||
description: 'Login Azure wraps the az login, allowing for Azure actions to log into Azure'
|
description: 'Authenticate to Azure and run your Az CLI or Az PowerShell based Actions or scripts. github.com/Azure/Actions'
|
||||||
inputs:
|
inputs:
|
||||||
creds: # id of input
|
creds:
|
||||||
description: 'Paste the contents of `az ad sp create-for-rbac... as value of secret variable: AZURE_CREDENTIALS'
|
description: 'Paste output of `az ad sp create-for-rbac` as value of secret variable: AZURE_CREDENTIALS'
|
||||||
required: true
|
required: true
|
||||||
|
enable-AzPSSession:
|
||||||
|
description: 'Set this value to true to enable Azure PowerShell Login in addition to Az CLI login'
|
||||||
|
required: false
|
||||||
|
default: false
|
||||||
branding:
|
branding:
|
||||||
icon: 'login.svg'
|
icon: 'login.svg'
|
||||||
color: 'blue'
|
color: 'blue'
|
||||||
runs:
|
runs:
|
||||||
using: 'node12'
|
using: 'node12'
|
||||||
main: 'main.js'
|
main: 'lib/main.js'
|
||||||
```
|
```
|
||||||
|
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|||||||
Reference in New Issue
Block a user