关于通过Azure DevOps API创建部署阶段及部署含IIS配置Web应用的技术咨询

Hey Dominik, great questions—let’s break this down clearly based on my experience working with Azure DevOps APIs and IIS deployments:

Absolutely! The Azure DevOps REST API fully supports creating and modifying deployment stages as part of release definitions. Here’s a practical breakdown of how to approach this:

Key Steps to Implement: #

1. Authenticate with a PAT: You’ll need a Personal Access Token (PAT) with at least Edit permissions for Release Management in your Azure DevOps project.
2. Use the Release Definition API: The core endpoint to update or create a release definition with new stages is:

   POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=7.1-preview.7
   

   For updating an existing definition, use PUT instead of POST.
3. Define Your Stage in the Request Body: Include a new stage object in the environments array of the release definition. This stage should specify:
   • Target servers (via deployment groups or Azure resources)
   • Deployment tasks (like IIS Web App Deployment or custom scripts)
   • Environment-specific variables

Example PowerShell Snippet (Adding a Stage to an Existing Definition): #

# Replace these values with your own
$pat = "your-pat-token"
$orgName = "YourOrganization"
$projectName = "YourProject"
$defId = 123 # ID of your existing release definition

$base64AuthInfo = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$pat"))
$defUrl = "https://vsrm.dev.azure.com/$orgName/$projectName/_apis/release/definitions/$defId?api-version=7.1-preview.7"

# Fetch existing release definition
$existingDef = Invoke-RestMethod -Uri $defUrl -Headers @{Authorization = "Basic $base64AuthInfo"} -Method Get

# Define new deployment stage
$newStage = @{
    name = "Production Web Server Deployment"
    rank = $existingDef.environments.Count + 1
    deploymentJobs = @(
        @{
            jobId = "deploy-web-app-task"
            tasks = @(
                @{
                    taskId = "e213ff0f-5d5c-4791-802d-52ea3e7be1f1" # IIS Web App Deployment task ID
                    inputs = @{
                        webAppName = "YourWebApp"
                        package = "$(System.DefaultWorkingDirectory)/drop/*.zip"
                        setParametersFile = "$(System.DefaultWorkingDirectory)/drop/SetParameters.xml"
                    }
                }
            )
        }
    )
}

# Add the new stage and update the definition
$existingDef.environments += $newStage
Invoke-RestMethod -Uri $defUrl -Headers @{Authorization = "Basic $base64AuthInfo"} -Method Put -Body ($existingDef | ConvertTo-Json -Depth 10) -ContentType "application/json"

When deploying web apps with IIS configuration through the Azure DevOps API, these approaches will ensure reliability and consistency:

1. Embed IIS Config Tasks Directly in the Stage #

Use built-in or custom tasks within your deployment stage to handle IIS setup:

• The IIS Web App Deployment task (used in the snippet above) can apply web.config transformations, configure app pools, and set up HTTP/HTTPS bindings automatically.
• For custom configurations (like URL rewrite rules or application settings), add a PowerShell Task that runs scripts using appcmd.exe or the WebAdministration module to modify IIS settings directly on the server.

2. Store IIS Config as Infrastructure-as-Code (IaC) #

Keep your IIS configuration files (e.g., rewrite rule XMLs, applicationHost.config snippets) in your source control repository. When triggering a deployment via API, include tasks that copy these files to the target server and apply them. This lets you track config changes over time and roll back if needed.

3. Use Variable Groups for Environment-Specific Settings #

Create variable groups in Azure DevOps for each environment (dev, staging, prod) to store IIS-specific values like:

• App pool name and .NET runtime version
• HTTP/HTTPS binding ports
• Connection strings

Reference these variables in your task inputs via the API to avoid hardcoding values, making your deployment pipeline flexible across environments.

4. Validate Post-Deployment IIS Configuration #

Add a validation step to your stage (via API) that runs a script to check:

• The web app is running and responding to requests
• IIS settings match the expected configuration (e.g., app pool is started, bindings are correct)
• Deployment logs show no critical errors

You can use the Azure DevOps API to mark the stage as successful or failed based on these checks, ensuring only valid deployments proceed.

5. Leverage Deployment Groups for On-Prem Servers #

If your IIS servers are on-premises, set up a deployment group in Azure DevOps and register your servers to it. When creating the stage via API, target this group—this simplifies managing access and deployment to your on-prem infrastructure.

内容的提问来源于stack exchange，提问作者VSO