Azure Administrator対策「Azure PowerShellの命名規約」

はじめに

AZ-103「Azure Administrator」対策として、Azure PowerShellの 各コマンドを記憶しやすくするため、Azure PowerShellの命名規約を記載する。

Azure PowerShellの命名規

https://docs.microsoft.com/ja-jp/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands?view=powershell-7

類似の動詞

NewとSetとUpdate

  • New

新しいリソースを作成するために使用。

# 仮想マシンを作成
New-AzVm `
    -ResourceGroupName "myResourceGroup" `
    -Name "myVM" `
    -Location "East US" `
    -VirtualNetworkName "myVnet" `
    -SubnetName "mySubnet" `
    -SecurityGroupName "myNetworkSecurityGroup" `
    -PublicIpAddressName "myPublicIpAddress" `
    -OpenPorts 80,3389
  • Set

対象のリソースが存在しない場合にリソースを作成、

また、既存のリソースを変更するために使用される

# VMを一般化(マシンとユーザーの固有の情報を VM から削除する)
Set-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07" -Generalized
  • Update

仮想マシンの状態を最新化する。

仮想マシンオブジェクトに対して変更した内容を、 仮想マシンに反映させる。

RDBにおけるコミットと同じようなものと思われる。

# 仮想マシンオブジェクトにデータディスクを追加
$vm = Add-AzVMDataDisk -VM $vm -Name "myDataDisk" -CreateOption Attach -ManagedDiskId $dataDisk.Id -Lun 1

# 仮想マシンオブジェクトの内容を仮想マシンに反映
Update-AzVM -ResourceGroupName "myResourceGroup" -VM $vm

FindとSearch

  • Find

オブジェクトを探すために使用。

  • Search

コンテナ内のリソースへの参照を作成するために使用。

GetとRead

  • Get

リソースのオブジェクトを取得するために使用。

# 指定したリソースグループの仮想マシンを取得
$vm = Get-AzVM -ResourceGroupName "myResourceGroup" -Name "myVM"
  • Read

ファイルなどの中身の情報を取得するために使用。

起動と開始

  • Invoke

同期を取って動作する処理を実行するために使用。

# VMを停止する
Invoke-AzResourceAction -ResourceGroupName testGroup -ResourceName testVM -ResourceType Microsoft.Compute/virtualMachines/ -Action Poweroff -Force
  • Start

非同期で動作する処理を開始するために使用。

# VMを起動する
Start-AzVM -ResourceGroupName "ResourceGroup11" -Name "VirtualMachine07"

Azure CLIとPowerShellの相違点

PowerShell CLI
動詞 対象リソース 対象リソース 動詞
Start-AzVM az vm start
Stop-AzVM az vm stop