VirtualMachineRunCommand interface
仮想マシンの実行コマンドについて説明します。
- Extends
プロパティ
async |
省略可能。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトの完了を待機しません。 |
error |
errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity 。 https://aka.ms/RunCommandManaged |
error |
スクリプト エラー ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照してください。 |
instance |
仮想マシンの実行コマンド インスタンス ビュー。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
output |
outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity 。 https://aka.ms/RunCommandManaged |
output |
スクリプト出力ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照してください。 |
parameters | スクリプトで使用されるパラメーター。 |
protected |
スクリプトで使用されるパラメーター。 |
provisioning |
プロビジョニング状態。これは応答にのみ表示されます。 treatFailureAsDeploymentFailure が true に設定されている場合、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は失敗としてマークされます。 treatFailureAsDeploymentFailure が false に設定されている場合、ProvisioningState は実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみが反映され、スクリプトエラーが発生した場合にスクリプトが失敗したかどうかは示されません。 スクリプトエラーが発生した場合は、run コマンドのインスタンス ビューを参照して、executionMessage、output、error: https://aka.ms/runcommandmanaged#get-execution-status-and-results NOTE: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
run |
実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。 |
run |
run コマンドの実行時に VM 上のユーザー アカウントを指定します。 |
source | run コマンド スクリプトのソース。 |
timeout |
実行コマンドを実行するためのタイムアウト (秒単位)。 |
treat |
省略可能。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみが反映されます。スクリプトが失敗した場合にスクリプトが失敗したかどうかは示されません。 スクリプトエラーが発生した場合の run コマンドのインスタンス ビューを参照して、executionMessage、output、error を表示します。 https://aka.ms/runcommandmanaged#get-execution-status-and-results |
継承されたプロパティ
id | リソース ID 注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
location | リソースの場所 |
name | リソース名注: このプロパティはシリアル化されません。 これは、サーバーによってのみ設定できます。 |
tags | リソース タグ |
type | リソースの種類注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。 |
プロパティの詳細
asyncExecution
省略可能。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトの完了を待機しません。
asyncExecution?: boolean
プロパティ値
boolean
errorBlobManagedIdentity
errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity 。 https://aka.ms/RunCommandManaged
errorBlobManagedIdentity?: RunCommandManagedIdentity
プロパティ値
errorBlobUri
スクリプト エラー ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照してください。
errorBlobUri?: string
プロパティ値
string
instanceView
仮想マシンの実行コマンド インスタンス ビュー。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
instanceView?: VirtualMachineRunCommandInstanceView
プロパティ値
outputBlobManagedIdentity
outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てで、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID とコマンドの実行の詳細については、 と を参照してください https://aka.ms/ManagedIdentity 。 https://aka.ms/RunCommandManaged
outputBlobManagedIdentity?: RunCommandManagedIdentity
プロパティ値
outputBlobUri
スクリプト出力ストリームをアップロードする Azure ストレージ BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照してください。
outputBlobUri?: string
プロパティ値
string
parameters
protectedParameters
スクリプトで使用されるパラメーター。
protectedParameters?: RunCommandInputParameter[]
プロパティ値
provisioningState
プロビジョニング状態。これは応答にのみ表示されます。 treatFailureAsDeploymentFailure が true に設定されている場合、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は失敗としてマークされます。 treatFailureAsDeploymentFailure が false に設定されている場合、ProvisioningState は実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみが反映され、スクリプトエラーが発生した場合にスクリプトが失敗したかどうかは示されません。 スクリプトエラーが発生した場合は、run コマンドのインスタンス ビューを参照して、executionMessage、output、error: https://aka.ms/runcommandmanaged#get-execution-status-and-results NOTE: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
provisioningState?: string
プロパティ値
string
runAsPassword
実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。
runAsPassword?: string
プロパティ値
string
runAsUser
run コマンドの実行時に VM 上のユーザー アカウントを指定します。
runAsUser?: string
プロパティ値
string
source
run コマンド スクリプトのソース。
source?: VirtualMachineRunCommandScriptSource
プロパティ値
timeoutInSeconds
実行コマンドを実行するためのタイムアウト (秒単位)。
timeoutInSeconds?: number
プロパティ値
number
treatFailureAsDeploymentFailure
省略可能。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみが反映されます。スクリプトが失敗した場合にスクリプトが失敗したかどうかは示されません。 スクリプトエラーが発生した場合の run コマンドのインスタンス ビューを参照して、executionMessage、output、error を表示します。 https://aka.ms/runcommandmanaged#get-execution-status-and-results
treatFailureAsDeploymentFailure?: boolean
プロパティ値
boolean
継承されたプロパティの詳細
id
location
name
tags
リソース タグ
tags?: {[propertyName: string]: string}
プロパティ値
{[propertyName: string]: string}
Resource.tagsから継承