Azure DevTest Labs 用の Azure PowerShell サンプル

この記事には、Azure DevTest Labs 用の次のサンプル Azure PowerShell スクリプトが含まれています。

外部ユーザーをラボに追加する
ラボでカスタムロールを作成して割り当てる
ラボで許可される仮想マシン (VM) サイズを設定する
Marketplace イメージをラボに追加する
仮想ハードドライブ (VHD) からカスタムイメージを作成する

前提条件

ユーザーまたはロールを追加または割り当てるには、ラボの 所有者 ロール、またはラボを含む Azure サブスクリプションの 所有者 または ユーザーアクセス管理者 ロールが必要です。
許可されているラボ VM のサイズを設定したり、Marketplace イメージを追加したり、カスタムイメージを作成したりするには、ラボまたは Azure サブスクリプションで少なくとも 共同作成者 ロールが必要です。
すべてのスクリプトには Azure PowerShell が必要です。 Azure Cloud Shell を使用することも、PowerShell をローカルにインストールすることもできます。
- Cloud Shell で、 PowerShell 環境を選択します。
- ローカル PowerShell インストールの場合は、 Update-Module -Name Az を実行して最新バージョンの Azure PowerShell を取得し、 Connect-AzAccount を実行して Azure にサインインします。複数の Azure サブスクリプションがある場合は、 Set-AzContext -SubscriptionId "<SubscriptionId>" を使用して、使用するサブスクリプション ID を指定します。

外部ユーザーをラボに追加する

このサンプル PowerShell スクリプトは、 DevTest Labs ユーザーロールを持つラボに外部ユーザーを追加します。追加するユーザーは、組織の Microsoft Entra ID に含まれている必要があります。

スクリプトを使用するには、 # Values to change コメントのパラメーター値を独自の値に置き換えます。 subscriptionId、labResourceGroup、labNameの値は、Azure portal のラボのメインページから取得できます。

このスクリプトでは以下のコマンドを使用します。

Get-AzADUser: Microsoft Entra ID からユーザーオブジェクトを取得します。
New-AzRoleAssignment: 指定したスコープの指定した ユーザーに DevTest Labs ユーザー ロールを割り当てます。

# Values to change
$subscriptionId = "<Azure subscription ID>"
$labResourceGroup = "<Lab resource group name>"
$labName = "<Lab name>"
$userDisplayName = "<User display name in Microsoft Entra ID>"

# Select the Azure subscription that contains the lab. This step is optional if you have only one subscription.
Select-AzSubscription -SubscriptionId $subscriptionId

# Get the user object.
$adObject = Get-AzADUser -SearchString $userDisplayName

# Assign the role. 
$labId = ('/subscriptions/' + $subscriptionId + '/resourceGroups/' + $labResourceGroup + '/providers/Microsoft.DevTestLab/labs/' + $labName)
New-AzRoleAssignment -ObjectId $adObject.Id -RoleDefinitionName 'DevTest Labs User' -Scope $labId

カスタムラボユーザーロールを作成して割り当てる

この PowerShell サンプルスクリプトでは、ラボユーザーがラボポリシーを変更できるカスタムロールを作成し、カスタムロールを外部ユーザーに割り当てます。ロールを割り当てるユーザーは、組織の Microsoft Entra ID に含まれている必要があります。

スクリプトを使用するには、 # Values to change コメントのパラメーター値を独自の値に置き換えます。 subscriptionId、rgName、labNameの値は、Azure portal のラボのメインページから取得できます。

このスクリプトでは以下のコマンドを使用します。

Get-AzProviderOperation: Microsoft.DevTestLab リソースプロバイダーで使用可能なすべての操作を一覧表示します。
Get-AzRoleDefinition: DevTest Labs ユーザー ロールに対して許可されているすべてのアクションを一覧表示します。
New-AzRoleDefinition: 新しい ポリシー共同作成者 カスタムロールを作成します。
New-AzRoleAssignment: 指定したスコープで、指定したユーザーにカスタムロールを割り当てます。

# Values to change
$subscriptionId = "<Azure subscription ID>"
$rgName = "<Lab resource group name>"
$labName = "<Lab name>"
$userDisplayName = "<User display name in Microsoft Entra ID>"

# List all the operations for a resource provider.
Get-AzProviderOperation -OperationSearchString "Microsoft.DevTestLab/*"

# List allowed actions for a role.
(Get-AzRoleDefinition "DevTest Labs User").Actions

# Create the custom role.
$policyRoleDef = (Get-AzRoleDefinition "DevTest Labs User")
$policyRoleDef.Id = $null
$policyRoleDef.Name = "Policy Contributor"
$policyRoleDef.IsCustom = $true
$policyRoleDef.AssignableScopes.Clear()
$policyRoleDef.AssignableScopes.Add("/subscriptions/" + $subscriptionId)
$policyRoleDef.Actions.Add("Microsoft.DevTestLab/labs/policySets/policies/*")
$policyRoleDef = (New-AzRoleDefinition -Role $policyRoleDef)

# Retrieve the user object.
$adObject = Get-AzADUser -SearchString $userDisplayName

# Create the role assignment. 
$scope = '/subscriptions/' + $subscriptionId + '/resourceGroups/' + $rgName + '/providers/Microsoft.DevTestLab/labs/' + $labName + '/policySets/default/policies/*'
New-AzRoleAssignment -ObjectId $adObject.Id -RoleDefinitionName "Policy Contributor" -Scope $scope

許可される VM サイズを設定する

この PowerShell サンプルスクリプトでは、ラボ VM の作成に使用できるサイズを設定します。プロンプトが表示されたときにスクリプトが呼び出す情報を指定します。

Get-AzResource: ラボおよびラボポリシーのリソースを取得します。
Set-AzResource: ラボ VM サイズポリシーを更新します。
New-AzResource: 新しいラボ VM サイズポリシーを作成します。

param (
[Parameter(Mandatory=$true, HelpMessage="The name of the DevTest Lab to update")]
    [string] $DevTestLabName,
[Parameter(Mandatory=$true, HelpMessage="The array of VM sizes to add")]
    [Array] $SizesToAdd
)

function Get-Lab
{
    $lab = Get-AzResource -ResourceType 'Microsoft.DevTestLab/labs' -Name $DevTestLabName

if(!$lab)
    {
        throw "Lab named $DevTestLabName was not found"
    }
    
    return $lab
}

function Get-PolicyChanges ($lab)
{
    #start by finding the existing policy
    $script:labResourceName = $lab.Name + '/default'
    $existingPolicy = (Get-AzResource -ResourceType 'Microsoft.DevTestLab/labs/policySets/policies' -Name $labResourceName -ResourceGroupName $lab.ResourceGroupName -ApiVersion 2016-05-15) | Where-Object {$_.Name -eq 'AllowedVmSizesInLab'}
    if($existingPolicy)
    {
        $existingSizes = $existingPolicy.Properties.threshold
        $savePolicyChanges = $false
    }
    else
    {
        $existingSizes = ''
        $savePolicyChanges = $true
    }

if($existingPolicy.Properties.threshold -eq '[]')
    {
        Write-Output "Skipping $($lab.Name) because it currently allows all sizes"
        return
    }

# Make a list of all the current allowed sizes plus the `$SizesToAdd`.
    $finalVmSizes = $existingSizes.Replace('[', '').Replace(']', '').Split(',',[System.StringSplitOptions]::RemoveEmptyEntries)

foreach($vmSize in $SizesToAdd)
    {
        $quotedSize = '"' + $vmSize + '"'

if(!$finalVmSizes.Contains($quotedSize))
        {
            $finalVmSizes += $quotedSize
            $savePolicyChanges = $true
        }
    }

if(!$savePolicyChanges)
    {
        Write-Output "No policy changes required for VMSize in lab $($lab.Name)"
    }

return @{
        existingPolicy = $existingPolicy
        savePolicyChanges = $savePolicyChanges
        finalVmSizes = $finalVmSizes
    }
}

function Set-PolicyChanges ($lab, $policyChanges)
{
    if($policyChanges.savePolicyChanges)
    {
        $thresholdValue = ('[' + [String]::Join(',', $policyChanges.finalVmSizes) + ']')

$policyObj = @{
            subscriptionId = $lab.SubscriptionId
            status = 'Enabled'
            factName = 'LabVmSize'
            resourceGroupName = $lab.ResourceGroupName
            labName = $lab.Name
            policySetName = 'default'
            name = $lab.Name + '/default/allowedvmsizesinlab'
            threshold = $thresholdValue
            evaluatorType = 'AllowedValuesPolicy'
        }

$resourceType = "Microsoft.DevTestLab/labs/policySets/policies/AllowedVmSizesInLab"
        if($policyChanges.existingPolicy)
        {
            Write-Output "Updating $($lab.Name) VM Size policy"
            Set-AzResource -ResourceType $resourceType -ResourceName $labResourceName -ResourceGroupName $lab.ResourceGroupName -ApiVersion 2016-05-15 -Properties $policyObj -Force
        }
        else
        {
            Write-Output "Creating $($lab.Name) VM Size policy"
            New-AzResource -ResourceType $resourceType -ResourceName $labResourceName -ResourceGroupName $lab.ResourceGroupName -ApiVersion 2016-05-15 -Properties $policyObj -Force
        }
    }
}

$lab = Get-Lab
$policyChanges = Get-PolicyChanges $lab
Set-PolicyChanges $lab $policyChanges

Marketplace イメージをラボに追加する

このサンプル PowerShell スクリプトは、ラボ VM の作成に使用できる基本イメージに Marketplace イメージを追加します。プロンプトが表示されたときにスクリプトが呼び出す情報を指定します。

このスクリプトでは、次のコマンドを使用します。

Get-AzResource: ラボ、ラボポリシー、ギャラリーイメージリソースを取得します。
Set-AzResource: 既存のラボ Marketplace イメージポリシーを変更します。
New-AzResource: 新しいラボのマーケットプレイスイメージポリシーを作成します。

param (
[Parameter(Mandatory=$true, HelpMessage="The name of the DevTest Lab to update")]
    [string] $DevTestLabName,
[Parameter(Mandatory=$true, HelpMessage="The array of Marketplace image names to enable")]
    [Array] $ImagesToAdd
)

function Get-Lab
{
    $lab = Get-AzResource -ResourceType 'Microsoft.DevTestLab/labs' -Name $DevTestLabName

if(!$lab)
    {
        throw "Lab named $DevTestLabName was not found"
    }
    
    return $lab
}

function Get-PolicyChanges ($lab)
{
    #start by finding the existing policy
    $script:labResourceName = $lab.Name + '/default'
    $existingPolicy = (Get-AzResource -ResourceType 'Microsoft.DevTestLab/labs/policySets/policies' -Name $labResourceName -ResourceGroupName $lab.ResourceGroupName -ApiVersion 2016-05-15) | Where-Object {$_.Name -eq 'GalleryImage'}
    if($existingPolicy)
    {
        $existingImages = [Array] (ConvertFrom-Json $existingPolicy.Properties.threshold)
        $savePolicyChanges = $false
    }
    else
    {
        $existingImages =  @()
        $savePolicyChanges = $true
    }

if($existingPolicy.Properties.threshold -eq '[]')
    {
        Write-Output "Skipping $($lab.Name) because it currently allows all marketplace images"
        return
    }

$allAvailableImages = Get-AzResource -ResourceType Microsoft.DevTestLab/labs/galleryImages -Name $lab.Name -ResourceGroupName $lab.ResourceGroupName -ApiVersion 2017-04-26-preview
    $finalImages = $existingImages

# loop through the requested images and add them to the finalImages list if they aren't already there
    foreach($image in $ImagesToAdd)
    {
        $imageObject = $allAvailableImages | Where-Object {$_.Name -eq $image}
        
        if(!$imageObject)
        {
            throw "Image $image is not available in the lab"
        }

$addImage = $true
        $parsedAvailableImage = $imageObject.Properties.imageReference

foreach($finalImage in $finalImages)
        {
            # determine whether or not the requested image is already allowed in this lab
            $parsedFinalImg = ConvertFrom-Json $finalImage

if($parsedFinalImg.offer -eq $parsedAvailableImage.offer -and $parsedFinalImg.publisher -eq $parsedAvailableImage.publisher -and $parsedFinalImg.sku -eq $parsedAvailableImage.sku -and $parsedFinalImg.osType -eq $parsedAvailableImage.osType -and $parsedFinalImg.version -eq $parsedAvailableImage.version)
            {
                $addImage = $false
                break
            }
        }

if($addImage)
        {
            Write-Output "  Adding image $image to the lab"
            $finalImages += ConvertTo-Json $parsedAvailableImage -Compress
            $savePolicyChanges = $true
        }
    }

if(!$savePolicyChanges)
    {
        Write-Output "No policy changes required for allowed Marketplace Images in lab $($lab.Name)"
    }

return @{
        existingPolicy = $existingPolicy
        savePolicyChanges = $savePolicyChanges
        finalImages = $finalImages
    }
}

function Set-PolicyChanges ($lab, $policyChanges)
{
    if($policyChanges.savePolicyChanges)
    {
        $thresholdValue = '["'
        for($i = 0; $i -lt $policyChanges.finalImages.Length; $i++)
        {
            $value = $policyChanges.finalImages[$i]
            if($i -ne 0)
            {
                $thresholdValue = $thresholdValue + '","'
            }

            $thresholdValue = $thresholdValue + $value.Replace('"', '\"')
        }
        $thresholdValue = $thresholdValue + '"]'

$policyObj = @{
            status = 'Enabled'
            factName = 'GalleryImage'
            threshold = $thresholdValue
            evaluatorType = 'AllowedValuesPolicy'
        }

$resourceType = "Microsoft.DevTestLab/labs/policySets/policies/galleryimage"
        if($policyChanges.existingPolicy)
        {
            Write-Output "Updating $($lab.Name) Marketplace Images policy"
            Set-AzResource -ResourceType $resourceType -ResourceName $labResourceName -ResourceGroupName $lab.ResourceGroupName -ApiVersion 2017-04-26-preview -Properties $policyObj -Force
        }
        else
        {
            Write-Output "Creating $($lab.Name) Marketplace Images policy"
            New-AzResource -ResourceType $resourceType -ResourceName $labResourceName -ResourceGroupName $lab.ResourceGroupName -ApiVersion 2017-04-26-preview -Properties $policyObj -Force
        }
    }
}

$lab = Get-Lab
$policyChanges = Get-PolicyChanges $lab
Set-PolicyChanges $lab $policyChanges

VHD ファイルからカスタムイメージを作成する

このサンプル PowerShell スクリプトでは、パブリック DevTest Labs テンプレートリポジトリのデプロイテンプレートを使用して、VHD ファイルから DevTest Labs カスタムイメージを作成します。このスクリプトには、ラボの Azure Storage アカウントにアップロードされた Windows VHD ファイルが必要です。

スクリプトを使用するには、 # Values to change コメントのパラメーター値を独自の値に置き換えます。 subscriptionId、labRg、labNameの値は、Azure portal のラボのメインページから取得できます。 VHD ファイルをアップロードした Azure Storage コンテナーから vhdUri 値を取得します。

このスクリプトでは以下のコマンドを使用します。

Get-AzResource: ラボとラボのストレージアカウントリソースを取得します。
Get-AzStorageAccountKey: ラボストレージアカウントのアクセスキーを取得します。
New-AzResourceGroupDeployment: テンプレートに基づいてカスタムイメージとリソースグループをデプロイします。

# Values to change
$subscriptionId = '<Azure subscription ID>'
$labRg = '<Lab resource group name>'
$labName = '<Lab name>'
$vhdUri = '<URI for the uploaded VHD>'
$customImageName = '<Name for the custom image>'
$customImageDescription = '<Description for the custom image>'

# Select the Azure subscription. 
Select-AzSubscription -SubscriptionId $subscriptionId

# Get the lab object.
$lab = Get-AzResource -ResourceId ('/subscriptions/' + $subscriptionId + '/resourceGroups/' + $labRg + '/providers/Microsoft.DevTestLab/labs/' + $labName)

# Get the lab storage account and lab storage account key values.
$labStorageAccount = Get-AzResource -ResourceId $lab.Properties.defaultStorageAccount 
$labStorageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $labStorageAccount.ResourceGroupName -Name $labStorageAccount.ResourceName)[0].Value

# Set up the parameters object.
$parameters = @{existingLabName="$($lab.Name)"; existingVhdUri=$vhdUri; imageOsType='windows'; isVhdSysPrepped=$false; imageName=$customImageName; imageDescription=$customImageDescription}

# Create the custom image.
New-AzResourceGroupDeployment -ResourceGroupName $lab.ResourceGroupName -Name CreateCustomImage -TemplateUri 'https://raw.githubusercontent.com/Azure/azure-devtestlab/master/samples/DevTestLabs/QuickStartTemplates/201-dtl-create-customimage-from-vhd/azuredeploy.json' -TemplateParameterObject $parameters

Azure PowerShell のドキュメント

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-04-17

Azure DevTest Labs 用の Azure PowerShell サンプル

前提条件

外部ユーザーをラボに追加する

カスタム ラボ ユーザー ロールを作成して割り当てる

許可される VM サイズを設定する

Marketplace イメージをラボに追加する

VHD ファイルからカスタム イメージを作成する

関連コンテンツ

フィードバック

その他のリソース

カスタムラボユーザーロールを作成して割り当てる

VHD ファイルからカスタムイメージを作成する