f711c0fc92 | ||
---|---|---|
.github | ||
__tests__ | ||
src | ||
.gitignore | ||
CODE_OF_CONDUCT.md | ||
LICENSE | ||
README.md | ||
SECURITY.md | ||
action.yml | ||
jest.config.js | ||
package-lock.json | ||
package.json | ||
tsconfig.json |
README.md
GitHub action for Azure PowerShell
This repository contains GitHub action for Azure PowerShell to automate your GitHub workflows using Azure PowerShell scripts.
Get started today with a free Azure account!
The definition of this GitHub Action is in action.yml.
[!NOTE] Azure PowerShell action now supports macOS and self-hosted Runners!
Dependencies on other GitHub Actions
Login to Azure before running Azure PowerShell scripts using Azure Login. Refer Azure Login action on how to configure Azure credentials.
Both Azure Login and Azure PowerShell action uses Az
module.
Once login is done, Azure PowerShell action will use the same session to run the script.
Sample Workflow
Sample workflow to run inlineScript
on: [push]
name: AzurePowerShellSample
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Login via Az module
uses: azure/login@v2
with:
creds: ${{secrets.AZURE_CREDENTIALS}}
enable-AzPSSession: true
- name: Run Azure PowerShell inline script
uses: azure/powershell@v2
with:
inlineScript: |
Get-AzVM -ResourceGroupName "ResourceGroup11"
azPSVersion: "latest"
Azure PowerShell Script to be executed can be given under inlineScript as shown in the sample workflow.
Azure PowerShell action is now supported for the Azure public cloud as well as Azure government clouds (AzureUSGovernment
or AzureChinaCloud
) and Azure Stack (AzureStack
) Hub. Before running Azure PowerShell scripts, login to the respective Azure Cloud using Azure Login action by setting appropriate value for the environment
parameter.
Additionally the action supports two optional parameters:
errorActionPreference
: select a suitable value for the variable for executing the script. Allowed values arestop
,continue
,silentlyContinue
. Default isStop
.failOnStandardError
: By default this is marked asfalse
. But if this is marked astrue
, the action will fail if any errors are written to the error pipeline, or if any data is written to the Standard Error stream.
Sample workflow to run a script file in your repository
# File: ./scripts/run_azps_cmdlets.ps1
on: [push]
name: AzurePowerShellSampleWithFile
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Check Out
uses: actions/checkout@v3
- name: Login Azure
uses: azure/login@v2
with:
creds: ${{secrets.AZURE_CREDENTIALS}}
enable-AzPSSession: true
- name: Run Azure PowerShell Script File
uses: azure/powershell@v2
with:
inlineScript: ./scripts/run_azps_cmdlets.ps1
azPSVersion: "latest"
You have to check out the repository before running the script file. You can also run the script file with parameters. For example:
- name: Run Azure PowerShell Script File
uses: azure/powershell@v2
with:
inlineScript: ./scripts/run_azps_cmdlets.ps1 myresourcegroup myresourcename
azPSVersion: "latest"
or
- name: Run Azure PowerShell Script File
uses: azure/powershell@v2
with:
inlineScript: ./scripts/run_azps_cmdlets.ps1 -ResourceGroupName myresourcegroup -ResourceName myresourcename
azPSVersion: "latest"
Sample workflow to run Azure powershell actions in Azure US Government cloud
- name: Login to Azure US Gov Cloud with Az Powershell
uses: azure/login@v2
with:
creds: ${{ secrets.AZURE_US_GOV_CREDENTIALS }}
environment: 'AzureUSGovernment'
enable-AzPSSession: true
- name: Run powershell command in US Gov Cloud
uses: azure/powershell@v2
with:
inlineScript: "Get-AzContext"
azPSVersion: "latest"
Available versions of Az Module on runner
To use the latest Az module version, specify latest
. You can find the latest Az module versions on different runner images from this table.
Or you can find all supported Az
version on PowerShell Gallery.
Getting Help for Azure PowerShell Issues
If you encounter an issue related to the Azure PowerShell commands executed in your script, you can file an issue directly on the Azure PowerShell repository.
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.