Azure DevOps

https://learn.microsoft.com/en-us/azure/devops/
Admin
Azure DevOps is a suite of development tools for planning, building, testing, and deploying...
Tokens:4,104,901
Snippets:35,120
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example pipeline using Go@0

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/go-v0

Example pipeline that uses GoTool@0 to install Go 1.10, then Go@0 to run 'go get' and 'go build', archives the build output, and publishes it as an artifact. The variables define Go paths and the module path.

```yaml
variables:
  GOBIN:  '$(GOPATH)/bin' # Go binaries path
  GOROOT: '/usr/local/go1.11' # Go installation path
  GOPATH: '$(system.defaultWorkingDirectory)/gopath' # Go workspace path
  modulePath: '$(GOPATH)/src/github.com/$(build.repository.name)' # Path to the module's code

steps:
- task: GoTool@0
  displayName: 'Use Go 1.10'

- task: Go@0
  displayName: 'go get'
  inputs:
    arguments: '-d'

- task: Go@0
  displayName: 'go build'
  inputs:
    command: build
    arguments: '-o "$(System.TeamProject).exe"'

- task: ArchiveFiles@2
  displayName: 'Archive files'
  inputs:
    rootFolderOrFile: '$(Build.Repository.LocalPath)'
    includeRootFolder: False

- task: PublishBuildArtifacts@1
  displayName: 'Publish artifact'
  condition: succeededOrFailed()

```

--------------------------------

### CmdLine@2 examples

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/cmd-line-v2

Example steps using the script shortcut to get the date, list directory contents, and set and display environment variables.

```yaml
steps:
- script: date /t
  displayName: Get the date
- script: dir
  workingDirectory: $(Agent.BuildDirectory)
  displayName: List contents of a folder
- script: |
    set MYVAR=foo
    set
  displayName: Set a variable and then display all
  env:
    aVarFromYaml: someValue

```

--------------------------------

### Install agent service with ./svc.sh install

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/agents/osx-agent

Creates a launchd plist that points to ./runsvc.sh, which sets up the environment and starts the agent's host.

```bash
./svc.sh install

```

--------------------------------

### Release deployment started

Source: https://learn.microsoft.com/en-us/azure/devops/service-hooks/events

This event is triggered when a release deployment starts. It provides details about the deployment, including the release, environment, and status.

```APIDOC
## Event: Release deployment started

### Description
This event is triggered when a release deployment starts. It provides details about the deployment, including the release, environment, and status.

### Publisher ID
`rm`

### Event ID
`ms.azure-devops-release.deployment-started-event`

### Resource Name
`resource`

### Settings
- `releaseEnvironmentId`: Include only events for deployments in a specific environment.
- `releaseDefinitionId`: Include only events for deployments for a specific pipeline.

### Sample Payload
```json
{
    "id": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
    "eventType": "ms.azure-devops-release.deployment-started-event",
    "publisherId": "rm",
    "message": {
        "text": "Deployment of release Release-5 to stage Dev started.",
        "html": "Deployment on stage <a href='http://fabfiber.visualstudio.com/Fabrikam-Fiber-Git/_apps/hub/ms.azure-devops-releaseManagement-web.hub-explorer?_a=environment-summary&definitionEnvironmentId=1&definitionId=4'>Dev</a> started.",
        "markdown": "Deployment on stage [Dev](https://fabfiber.visualstudio.com/Fabrikam-Fiber-Git/_apps/hub/ms.azure-devops-releaseManagement-web.hub-explorer?_a=environment-summary&definitionEnvironmentId=1&definitionId=4) started."
    },
    "detailedMessage": {
        "text": "Deployment of release Release-5 on stage Dev started.\r\nTrigger: Manual",
        "html": "Deployment on stage <a href='Dev'>http://fabfiber.visualstudio.com/Fabrikam-Fiber-Git/_apps/hub/ms.azure-devops-releaseManagement-web.hub-explorer?_a=environment-summary&definitionEnvironmentId=1&definitionId=4</a> started.<br>Trigger: Manual",
        "markdown": "Deployment on stage [Release-1](https://fabfiber.visualstudio.com/Fabrikam-Fiber-Git/_apps/hub/ms.azure-devops-releaseManagement-web.hub-explorer?_a=environment-summary&definitionEnvironmentId=1&definitionId=4) started.\r\nTrigger: Dev"
    },
    "resource": {
        "environment": {
            "id": 5,
            "releaseId": 0,
            "name": "Dev",
            "status": "queued",
            "variables": {},
            "variableGroups": [],
            "preDeployApprovals": [],
            "postDeployApprovals": [],
            "preApprovalsSnapshot": {
                "approvals": [],
                "approvalOptions": {
                    "requiredApproverCount": 0,
                    "releaseCreatorCanBeApprover": true
                }
            }
        }
    }
}
```
```

--------------------------------

### Get Azure DevOps repository GUID with Azure CLI

Source: https://learn.microsoft.com/en-us/azure/devops/repos/enterprise-live-migrations/prerequisites

Use this command to retrieve the GUID of an Azure DevOps repository. The output is the repository GUID, which you should save for use when starting the migration.

```azure cli
az repos show --repository <repo-name> --query id -o tsv

```

--------------------------------

### Example: full environment syntax

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/jobs-deployment-environment

Full syntax example with comments explaining each property and a runOnce deployment strategy.

```yaml
environment:            # create environment and/or record deployments
  name: string          # name of the environment to run this job on.
  resourceName: string  # name of the resource in the environment to record the deployments against
  resourceId: number    # resource identifier
  resourceType: string  # type of the resource you want to target. Supported types - virtualMachine, Kubernetes
  tags: string          # comma separated tag names to filter the resources in the environment
strategy:               # deployment strategy
  runOnce:              # default strategy
    deploy:
      steps:
      - script: echo Hello world

```

--------------------------------

### Example: Delete wiki page

Source: https://learn.microsoft.com/en-us/azure/devops/project/wiki/add-edit-wiki

Deletes the 'Get Started' page in a wiki named 'MyProjectwiki'. This command is not supported for Azure DevOps Server.

```azure cli
az devops wiki page delete --path 'Get Started' --wiki 'MyProjectwiki'

```

--------------------------------

### View a specific wiki page with az devops wiki page show

Source: https://learn.microsoft.com/en-us/azure/devops/project/wiki/wiki-create-repo

Gets the content of the 'Get Started' page in the 'MyProjectwiki' wiki. The `--content` parameter is used to specify the content to display, though the example shows a placeholder value.

```azurecli
az devops wiki page show --path 'Get Started' --wiki 'MyProjectwiki' --content "Hello World"

```

--------------------------------

### Example: Open a Visual Studio solution from a cloned repo using the command line

Source: https://learn.microsoft.com/en-us/azure/devops/repos/git/clone

Example of the command to open a specific solution file from a cloned repo.

```console
start C:\Repos\FiberTests\FiberTests.sln

```

--------------------------------

### Example SQL command for migration setup

Source: https://learn.microsoft.com/en-us/azure/devops/migrate/migration-prepare-test-run

Example SQL command combining the recovery model change and authentication creation. Uses database Foo and login fabrikam.

```SQL
    ALTER DATABASE [Foo] SET RECOVERY SIMPLE; 
     
    USE [Foo] 
    CREATE LOGIN fabrikam WITH PASSWORD = 'fabrikampassword' 
    CREATE USER fabrikam FOR LOGIN fabrikam WITH DEFAULT_SCHEMA=[dbo] 
    EXEC sp_addrolemember @rolename='TFSEXECROLE', @membername='fabrikam'

```

--------------------------------

### Install and start Docker Desktop

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/ecosystems/containers/publish-to-acr

Installs and starts Docker Desktop. Run this from the download path after downloading the installer.

```powershell
Start-Process 'Docker%20Desktop%20Installer.exe' -Wait install

```

--------------------------------

### Startup command example (dotnet exec)

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/azure-rm-web-app-deployment-v4

Startup command examples for Azure App Service tasks. Use the first when a specific executable is required; use the second as a shorter alternative. Both run the .NET DLL as the startup command.

```bash
dotnet exec `filename.dll`
```

```bash
dotnet `filename.dll`
```

--------------------------------

### Full Dockerfile example for nonglibc-based containers

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/process/container-phases

Complete Dockerfile for a nonglibc-based container (Alpine) that supplies its own Node.js, installs required packages, and sets the handler node path label. Use this as a starting point for pipelines that run on Alpine-based images.

```Dockerfile
FROM node:18-alpine

RUN apk add --no-cache --virtual .pipeline-deps readline linux-pam \
  && apk add bash sudo shadow \
  && apk del .pipeline-deps

LABEL "com.azure.dev.pipelines.agent.handler.node.path"="/usr/local/bin/node"

CMD [ "node" ]

```

--------------------------------

### Example: environment string with resource name

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/yaml-schema/jobs-deployment-environment

Example of using the string syntax with a resource name and a runOnce deployment strategy.

```yaml
environment: environmentName.resourceName
strategy:                 # deployment strategy
  runOnce:              # default strategy
    deploy:
      steps:
      - script: echo Hello world

```

--------------------------------

### Start agent service

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/agents/linux-agent

Starts the agent service that was installed with svc.sh.

```bash
sudo ./svc.sh start
```

--------------------------------

### Subscribe to a project (example URL)

Source: https://learn.microsoft.com/en-us/azure/devops/repos/integrations/repos-slack

Example of subscribing to a project using a specific project URL.

```bash
/azrepos subscribe https://dev.azure.com/myorg/myproject/

```

--------------------------------

### HelmDeploy install command example

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/helm-deploy-v0

Use this YAML example to run the 'install' helm command with a chart from a file path. It sets chartType to 'FilePath' and specifies the chartPath.

```YAML
- task: HelmDeploy@0
  displayName: Helm install
  inputs:
    azureSubscriptionEndpoint: $(azureSubscriptionEndpoint)
    azureResourceGroup: $(azureResourceGroup)
    kubernetesCluster: $(kubernetesCluster)
    command: install
    chartType: FilePath
    chartPath: Application/charts/sampleapp

```

--------------------------------

### Advanced setup starter pipeline for CodeQL scanning

Source: https://learn.microsoft.com/en-us/azure/devops/repos/security/github-advanced-security-code-scanning

Starter Azure Pipelines YAML for advanced CodeQL setup. Add tasks in order: AdvancedSecurity-Codeql-Init@1, custom build steps, then AdvancedSecurity-Codeql-Analyze@1. Specify languages as a comma-separated list (csharp, cpp, go, java, javascript, python, ruby, swift); use 'java' for Java/Kotlin and 'javascript' for JavaScript/TypeScript. For self-hosted agents, enableAutomaticCodeQLInstall: true installs the latest CodeQL bits automatically. Custom build steps are required when analyzing swift.

```yaml
trigger:
  - main

pool:
  # Additional hosted image options are available: https://learn.microsoft.com/en-us/azure/devops/pipelines/agents/hosted#software
  vmImage: ubuntu-latest

steps:

  - task: AdvancedSecurity-Codeql-Init@1
    inputs:
      languages: "java"
      # Supported languages: csharp, cpp, go, java, javascript, python, ruby, swift
      # You can customize the initialize task: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/advanced-security-codeql-init-v1?view=azure-pipelines
      # If you're using a self-hosted agent to run CodeQL, use `enableAutomaticCodeQLInstall` to automatically use the latest CodeQL bits on your agent:
      enableAutomaticCodeQLInstall: true

#   Add your custom build steps here
# - Ensure that all code to be scanned is compiled (often using a `clean` command to ensure you're building from a clean state).
# - Disable the use of any build caching mechanisms as this can interfere with CodeQL's ability to capture all the necessary data during the build.
# - Disable the use of any distributed/multithreaded/incremental builds as CodeQL needs to monitor executions of the compiler to construct an accurate representation of the application.
# - For dependency scanning, ensure you have a package restore step for more accurate results.

# If you had a Maven app:
#   - task: Maven@4
#     inputs:
#       mavenPomFile: 'pom.xml'
#       goals: 'clean package'
#       publishJUnitResults: true
#       testResultsFiles: '**/TEST-*.xml'
#       javaHomeOption: 'JDKVersion'
#       jdkVersionOption: '1.17'
#       mavenVersionOption: 'Default'

# Or a general script:
#   - script: |
#       echo "Run, Build Application using script"
#       ./location_of_script_within_repo/buildscript.sh

  - task: AdvancedSecurity-Dependency-Scanning@1 # More details on this task: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/advanced-security-dependency-scanning-v1?view=azure-pipelines

  - task: AdvancedSecurity-Codeql-Analyze@1 # More details on this task: https://learn.microsoft.com/en-us/azure/devops/pipelines/tasks/reference/advanced-security-codeql-analyze-v1?view=azure-pipelines

```

--------------------------------

### Install Go dependencies with go get

Source: https://learn.microsoft.com/en-us/azure/devops/pipelines/ecosystems/go

Use `go get` to download the source code for a Go project or to install a tool into the Go workspace. Add this snippet to your `azure-pipelines.yml` file.

```yaml
- script: go get -v -t -d ./...
  workingDirectory: '$(modulePath)'
  displayName: 'go get dependencies'

```

--------------------------------

### Build package with setup.py

Source: https://learn.microsoft.com/en-us/azure/devops/artifacts/quickstarts/python-packages

Alternative command to build your package if your project has a setup.py file.

```bash
python setup.py sdist bdist_wheel
```
Tokens:
Raw