VirtualMachineRunCommand interface

パッケージ:

@azure/arm-compute

仮想マシンの実行コマンドについて説明します。

Extends

TrackedResource

プロパティ

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

継承されたプロパティ

id	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
location	リソースが存在する地理的な場所
name	リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。
tags	リソース タグ。
type	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

プロパティの詳細

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

プロパティ値

RunCommandManagedIdentity

errorBlobUri

スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照します。

errorBlobUri?: string

プロパティ値

string

instanceView

仮想マシンの実行コマンド インスタンス ビュー。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

instanceView?: VirtualMachineRunCommandInstanceView

プロパティ値

VirtualMachineRunCommandInstanceView

outputBlobManagedIdentity

outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。

outputBlobManagedIdentity?: RunCommandManagedIdentity

プロパティ値

RunCommandManagedIdentity

outputBlobUri

スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照します。

outputBlobUri?: string

プロパティ値

string

parameters

スクリプトで使用されるパラメーター。

parameters?: RunCommandInputParameter[]

プロパティ値

RunCommandInputParameter[]

protectedParameters

スクリプトで使用されるパラメーター。

protectedParameters?: RunCommandInputParameter[]

プロパティ値

RunCommandInputParameter[]

provisioningState

プロビジョニング状態。応答にのみ表示されます。 treatFailureAsDeploymentFailure が true に設定されている場合、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 treatFailureAsDeploymentFailure が false に設定されている場合、ProvisioningState は実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみを反映し、スクリプトが失敗した場合にスクリプトが失敗したかどうかを示しません。 スクリプトが失敗した場合の実行コマンドのインスタンスビューを参照して、executionMessage、output、error: https://aka.ms/runcommandmanaged#get-execution-status-and-results 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

provisioningState?: string

プロパティ値

string

runAsPassword

実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。

runAsPassword?: string

プロパティ値

string

runAsUser

実行コマンドの実行時に VM 上のユーザー アカウントを指定します。

runAsUser?: string

プロパティ値

string

source

実行コマンド スクリプトのソース。

source?: VirtualMachineRunCommandScriptSource

プロパティ値

VirtualMachineRunCommandScriptSource

timeoutInSeconds

run コマンドを実行するためのタイムアウト (秒単位)。

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

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

id?: string

プロパティ値

string

TrackedResource.id から継承された

location

リソースが存在する地理的な場所

location: string

プロパティ値

string

TrackedResource.location から継承

name

リソースの名前注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

name?: string

プロパティ値

string

TrackedResource.name から継承された

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

systemData?: SystemData

プロパティ値

SystemData

trackedResource.systemData から継承

tags

リソース タグ。

tags?: {[propertyName: string]: string}

プロパティ値

{[propertyName: string]: string}

TrackedResource.tags から継承された

type

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" 注: このプロパティはシリアル化されません。 サーバーによってのみ設定できます。

type?: string

プロパティ値

string

trackedResource.typeから継承された