Add-AzureProvisioningConfig

リファレンス

モジュール:: Azure

Azure 仮想マシンのプロビジョニング構成を追加します。

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。詳細については、Azure Service Manager の提供終了に関するページを参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

構文

Add-AzureProvisioningConfig
   -VM <IPersistentVM>
   [-DisableGuestAgent]
   [-CustomDataFile <String>]
   [-Windows]
   [-AdminUsername <String>]
   [-Password <String>]
   [-ResetPasswordOnFirstLogon]
   [-DisableAutomaticUpdates]
   [-NoRDPEndpoint]
   [-TimeZone <String>]
   [-Certificates <CertificateSettingList>]
   [-EnableWinRMHttp]
   [-DisableWinRMHttps]
   [-WinRMCertificate <X509Certificate2>]
   [-X509Certificates <X509Certificate2[]>]
   [-NoExportPrivateKey]
   [-NoWinRMEndpoint]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Add-AzureProvisioningConfig
   -VM <IPersistentVM>
   [-DisableGuestAgent]
   [-Linux]
   [-LinuxUser <String>]
   [-DisableSSH]
   [-NoSSHEndpoint]
   [-NoSSHPassword]
   [-SSHPublicKeys <SSHPublicKeyList>]
   [-SSHKeyPairs <SSHKeyPairList>]
   [-CustomDataFile <String>]
   [-Password <String>]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Add-AzureProvisioningConfig
   -VM <IPersistentVM>
   [-DisableGuestAgent]
   [-CustomDataFile <String>]
   -AdminUsername <String>
   [-WindowsDomain]
   [-Password <String>]
   [-ResetPasswordOnFirstLogon]
   [-DisableAutomaticUpdates]
   [-NoRDPEndpoint]
   [-TimeZone <String>]
   [-Certificates <CertificateSettingList>]
   -JoinDomain <String>
   -Domain <String>
   -DomainUserName <String>
   -DomainPassword <String>
   [-MachineObjectOU <String>]
   [-EnableWinRMHttp]
   [-DisableWinRMHttps]
   [-WinRMCertificate <X509Certificate2>]
   [-X509Certificates <X509Certificate2[]>]
   [-NoExportPrivateKey]
   [-NoWinRMEndpoint]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

説明

Add-AzureProvisioningConfig コマンドレットは、プロビジョニング構成情報を Azure 仮想マシンの構成に追加します。構成オブジェクトを使用して、仮想マシンを作成できます。

このコマンドレットは、スタンドアロンの Windows サーバー、Active Directory ドメインに参加している Windows サーバー、Linux ベースのサーバーなど、さまざまなプロビジョニング構成をサポートしています。

Active Directory ドメインに参加しているサーバーを作成するには、Active Directory ドメインの完全修飾ドメイン名と、仮想マシンをドメインに参加させるアクセス許可を持つユーザーのドメイン資格情報を指定します。

例

例 1: スタンドアロン仮想マシンを作成する

PS C:\> New-AzureVMConfig -Name "NonDomainVM" -InstanceSize Small -ImageName "Image07" | Add-AzureProvisioningConfig -Windows -Password "password" -AdminUsername "AdminMain" | New-AzureVM -ServiceName "ContosoService"

このコマンドは、New-AzureVMConfig コマンドレットを使用して仮想マシン構成オブジェクトを作成します。コマンドは、パイプライン演算子を使用して、そのオブジェクトを現在のコマンドレットに渡します。現在のコマンドレットは、Windows オペレーティングシステムを実行する仮想マシンのプロビジョニング構成を追加します。構成には、管理者のユーザー名とパスワードが含まれます。このコマンドは、仮想マシンを 作成する New-AzureVM コマンドレットに構成を渡します。

例 2: ドメインに参加している仮想マシンを作成する

PS C:\> New-AzureVMConfig -Name "DomainVM" -InstanceSize Small -ImageName "Image09" | Add-AzureProvisioningConfig -WindowsDomain -Password "password" -AdminUsername "AdminMain" -ResetPasswordOnFirstLogon -JoinDomain "contoso.com" -Domain "contoso" -DomainUserName "DomainAdminUser" -DomainPassword "DomainPassword" -MachineObjectOU 'OU=AzureVMs,DC=contoso,DC=com' | New-AzureVM -ServiceName "ContosoService"

このコマンドは、仮想マシン構成オブジェクトを作成し、現在のコマンドレットに渡します。現在のコマンドレットは、contoso ドメインに参加する仮想マシンのプロビジョニング構成を追加します。このコマンドには、仮想マシンをドメインに参加させるために必要なユーザー名とパスワードが含まれています。この構成では、ユーザーが最初のログオン時にユーザーパスワードを変更する必要があります。このコマンドは、プロビジョニングオブジェクトに基づいて仮想マシンを作成します。

例 3: Linux ベースの仮想マシンを作成する

PS C:\> New-AzureVMConfig -Name "LinuxVM" -InstanceSize Small -ImageName "LinuxImage03" | Add-AzureProvisioningConfig -Linux -LinuxUser "LinuxRoot" -Password "password" | New-AzureVM -ServiceName "ContosoService"

このコマンドは、仮想マシン構成オブジェクトを作成し、現在のコマンドレットに渡します。現在のコマンドレットは、Linux オペレーティングシステムを実行する仮想マシンのプロビジョニング構成を追加します。構成には、ルートユーザー名とパスワードが含まれます。このコマンドは、プロビジョニングオブジェクトに基づいて仮想マシンを作成します。

例 4: WinRM の証明書を含む仮想マシンを作成する

PS C:\> $certs = Get-ChildItem Cert:\CurrentUser\My
New-AzureVMConfig -Name "NonDomainVM" -InstanceSize Small -ImageName "Image11" | Add-AzureProvisioningConfig -Windows -Password "password" -AdminUsername "AdminMain" -WinRMCertificate $certs[0] -X509Certificates $certs[1], $certs[2] | New-AzureVM -ServiceName "ContosoService" -WaitForBoot

最初のコマンドは、証明書ストアから証明書を取得し、$certs配列変数に格納します。

2 番目のコマンドは、仮想マシン構成オブジェクトを作成し、それを現在のコマンドレットに渡します。現在のコマンドレットは、WinRM の証明書を含むプロビジョニング構成を追加します。このコマンドは、プロビジョニングオブジェクトに基づいて仮想マシンを作成します。

例 5: HTTP 経由で WinRM が有効になっている仮想マシンを作成する

PS C:\> New-AzureVMConfig -Name "NonDomainVM" -InstanceSize Small -ImageName "Image14" | Add-AzureProvisioningConfig -Windows -Password "password" -AdminUsername "AdminMain" -EnableWinRMHttp | New-AzureVM -ServiceName "ContosoService" -WaitForBoot

このコマンドは、仮想マシン構成オブジェクトを作成し、現在のコマンドレットに渡します。現在のコマンドレットは、HTTP 経由で WinRM が有効になっているプロビジョニング構成を追加します。このコマンドは、プロビジョニングオブジェクトに基づいて仮想マシンを作成します。

例 6: HTTPS で WinRM が無効になっている仮想マシンを作成する

PS C:\> New-AzureVMConfig -Name "NonDomainVM" -InstanceSize Small -ImageName "Image07" | Add-AzureProvisioningConfig -Windows -Password "password" -AdminUsername "AdminMain" -DisableWinRMHttps | New-AzureVM -ServiceName "ContosoService" -WaitForBoot

このコマンドは、仮想マシン構成オブジェクトを作成し、現在のコマンドレットに渡します。現在のコマンドレットは、HTTPS 経由で WinRM を無効にするプロビジョニング構成を追加します。このコマンドは、プロビジョニングオブジェクトに基づいて仮想マシンを作成します。

例 7: キーをエクスポートしない仮想マシンを作成する

PS C:\> $certs = Get-ChildItem Cert:\CurrentUser\My
New-AzureVMConfig -Name "NonDomainVM" -InstanceSize Small -ImageName "Image07" | Add-AzureProvisioningConfig -Windows -Password "password" -AdminUsername "AdminMain" -X509Certificates $certs[0], $certs[1] -NoExportPrivateKey | New-AzureVM -ServiceName "ContosoService" -WaitForBoot

最初のコマンドは、証明書ストアから証明書を取得し、$certs配列変数に格納します。

2 番目のコマンドは、仮想マシン構成オブジェクトを作成し、それを現在のコマンドレットに渡します。現在のコマンドレットは、証明書を含み、秘密キーをエクスポートしない仮想マシンのプロビジョニング構成を追加します。このコマンドは、プロビジョニングオブジェクトに基づいて仮想マシンを作成します。

パラメーター

-AdminUsername

この構成が仮想マシン上に作成する管理者アカウントのユーザー名を指定します。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Certificates

この構成が仮想マシンにインストールする証明書のセットを指定します。

型:	CertificateSettingList
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CustomDataFile

仮想マシンのデータファイルを指定します。このコマンドレットは、ファイルの内容を Base64 としてエンコードします。ファイルの長さは 64 KB 未満である必要があります。

ゲストオペレーティングシステムが Windows オペレーティングシステムの場合、この構成では、このデータが %SYSTEMDRIVE%\AzureData\CustomData.bin という名前のバイナリファイルとして保存されます。

ゲストオペレーティングシステムが Linux の場合、この構成では、ovf-env.xml ファイルを使用してデータが渡されます。構成では、そのファイルが /var/lib/waagent ディレクトリにコピーされます。エージェントは、Base64 でエンコードされたデータも /var/lib/waagent/CustomData に格納します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DisableAutomaticUpdates

この構成で自動更新が無効であることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DisableGuestAgent

この構成により、サービスとしてのインフラストラクチャ (IaaS) ゲストエージェントが無効になります。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DisableSSH

この構成で SSH が無効であることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DisableWinRMHttps

この構成で HTTPS の Windows リモート管理 (WinRM) が無効であることを示します。既定では、WinRM は HTTPS 経由で有効になっています。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Domain

コンピューターをドメインに追加するアクセス許可を持つアカウントのドメインの名前を指定します。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DomainPassword

コンピューターをドメインに追加するアクセス許可を持つユーザーアカウントのパスワードを指定します。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DomainUserName

コンピューターをドメインに追加するアクセス許可を持つユーザーアカウントの名前を指定します。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EnableWinRMHttp

この構成で HTTP 経由の WinRM が有効であることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InformationAction

このコマンドレットが情報イベントに応答する方法を指定します。

このパラメーターの有効値は、次のとおりです。

続行
Ignore
Inquire
SilentlyContinue
Stop
[中断]

型:	ActionPreference
Aliases:	infa
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InformationVariable

情報変数を指定します。

型:	String
Aliases:	iv
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-JoinDomain

参加するドメインの完全修飾ドメイン名 (FQDN) を指定します。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Linux

この構成によって Linux 構成が作成されることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-LinuxUser

この構成が仮想マシン上に作成する Linux 管理アカウントのユーザー名を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-MachineObjectOU

構成でコンピューターアカウントを作成する組織単位 (OU) の完全修飾名を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoExportPrivateKey

この構成で秘密キーがアップロードされないことを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoRDPEndpoint

この構成により、リモートデスクトップエンドポイントのない仮想マシンが作成されることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoSSHEndpoint

この構成により、SSH エンドポイントなしで仮想マシンが作成されることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoSSHPassword

この構成により、SSH パスワードなしで仮想マシンが作成されることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-NoWinRMEndpoint

この構成では、仮想マシンの WinRM エンドポイントが追加されないことを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Password

管理者アカウントのパスワードを指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

型:	AzureSMProfile
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResetPasswordOnFirstLogon

仮想マシンで、ユーザーが最初のログオン時にパスワードを変更する必要があることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SSHKeyPairs

SSH キーペアを指定します。

型:	SSHKeyPairList
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SSHPublicKeys

SSH 公開キーを指定します。

型:	SSHPublicKeyList
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-TimeZone

仮想マシンのタイムゾーン (太平洋標準時、カナダ中部標準時など) を指定します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-VM

仮想マシンオブジェクトを指定します。

型:	IPersistentVM
Aliases:	InputObject
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Windows

この構成により、Windows オペレーティングシステムを実行するスタンドアロン仮想マシンが作成されることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WindowsDomain

この構成により、Active Directory ドメインに参加している Windows サーバーが作成されることを示します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WinRMCertificate

この構成が WinRM エンドポイントに関連付ける証明書を指定します。

型:	X509Certificate2
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-X509Certificates

ホストされるサービスに展開される X509 証明書の配列を指定します。

型:	X509Certificate2[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

次の方法で共有