Microsoft.Compute virtualMachineScaleSets/virtualMachines/runCommands 2023-03-01
[アーティクル] 08/17/2024
1 人の共同作成者
フィードバック
この記事の内容
Bicep リソース定義
virtualMachineScaleSets/virtualMachines/runCommands リソースの種類は、次を対象とする操作でデプロイできます。
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
asyncExecution: bool
errorBlobManagedIdentity: {
clientId: 'string'
objectId: 'string'
}
errorBlobUri: 'string'
outputBlobManagedIdentity: {
clientId: 'string'
objectId: 'string'
}
outputBlobUri: 'string'
parameters: [
{
name: 'string'
value: 'string'
}
]
protectedParameters: [
{
name: 'string'
value: 'string'
}
]
runAsPassword: 'string'
runAsUser: 'string'
source: {
commandId: 'string'
script: 'string'
scriptUri: 'string'
scriptUriManagedIdentity: {
clientId: 'string'
objectId: 'string'
}
}
timeoutInSeconds: int
treatFailureAsDeploymentFailure: bool
}
}
プロパティ値
virtualMachineScaleSets/virtualMachines/runCommands
名前
形容
価値
名前
リソース名設定する方法を参照してください。
string (必須)
場所
リソースの場所
string (必須)
タグ
リソース タグ
タグ名と値のディクショナリ。 テンプレート の タグを参照してください
親
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。子リソース」を参照してください。
種類のリソースのシンボリック名: virtualMachines
プロパティ
仮想マシンの実行コマンドのプロパティについて説明します。
VirtualMachineRunCommandProperties
VirtualMachineRunCommandProperties
名前
形容
価値
asyncExecution
随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。
bool
errorBlobManagedIdentity
errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。
RunCommandManagedIdentity
errorBlobUri
スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照します。
糸
outputBlobManagedIdentity
outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。
RunCommandManagedIdentity
outputBlobUri
スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照します。
糸
パラメーター
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
protectedParameters
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
runAsPassword
実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。
糸
runAsUser
実行コマンドの実行時に VM 上のユーザー アカウントを指定します。
糸
源
実行コマンド スクリプトのソース。
VirtualMachineRunCommandScriptSource
timeoutInSeconds
run コマンドを実行するためのタイムアウト (秒単位)。
int
treatFailureAsDeploymentFailure
随意。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみを反映し、スクリプトが失敗した場合にスクリプトが失敗したかどうかを示しません。 executionMessage、output、error: https://aka.ms/runcommandmanaged#get-execution-status-and-results を表示するスクリプトエラーが発生した場合は、run コマンドのインスタンス ビューを参照してください
bool
RunCommandManagedIdentity
名前
形容
価値
clientId
ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。 ObjectId を指定する場合は使用しないでください。
糸
objectId
ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。 これが指定されている場合は、ClientId を使用しないでください。
糸
名前
形容
価値
名前
run コマンド のパラメーター名。
string (必須)
価値
run コマンド パラメーターの値。
string (必須)
VirtualMachineRunCommandScriptSource
名前
形容
価値
commandId
定義済みの組み込みスクリプトの commandId を指定します。
糸
スクリプト
VM で実行するスクリプトコンテンツを指定します。
糸
scriptUri
スクリプトのダウンロード場所を指定します。 読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。
糸
scriptUriManagedIdentity
Azure Storage BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged. を参照してください。
RunCommandManagedIdentity
ARM テンプレート リソース定義
virtualMachineScaleSets/virtualMachines/runCommands リソースの種類は、次を対象とする操作でデプロイできます。
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands",
"apiVersion": "2023-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"asyncExecution": "bool",
"errorBlobManagedIdentity": {
"clientId": "string",
"objectId": "string"
},
"errorBlobUri": "string",
"outputBlobManagedIdentity": {
"clientId": "string",
"objectId": "string"
},
"outputBlobUri": "string",
"parameters": [
{
"name": "string",
"value": "string"
}
],
"protectedParameters": [
{
"name": "string",
"value": "string"
}
],
"runAsPassword": "string",
"runAsUser": "string",
"source": {
"commandId": "string",
"script": "string",
"scriptUri": "string",
"scriptUriManagedIdentity": {
"clientId": "string",
"objectId": "string"
}
},
"timeoutInSeconds": "int",
"treatFailureAsDeploymentFailure": "bool"
}
}
プロパティ値
virtualMachineScaleSets/virtualMachines/runCommands
名前
形容
価値
種類
リソースの種類
'Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands'
apiVersion
リソース API のバージョン
'2023-03-01'
名前
リソース名設定する方法を参照してください。
string (必須)
場所
リソースの場所
string (必須)
タグ
リソース タグ
タグ名と値のディクショナリ。 テンプレート の タグを参照してください
プロパティ
仮想マシンの実行コマンドのプロパティについて説明します。
VirtualMachineRunCommandProperties
VirtualMachineRunCommandProperties
名前
形容
価値
asyncExecution
随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。
bool
errorBlobManagedIdentity
errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。
RunCommandManagedIdentity
errorBlobUri
スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照します。
糸
outputBlobManagedIdentity
outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。
RunCommandManagedIdentity
outputBlobUri
スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照します。
糸
パラメーター
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
protectedParameters
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
runAsPassword
実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。
糸
runAsUser
実行コマンドの実行時に VM 上のユーザー アカウントを指定します。
糸
源
実行コマンド スクリプトのソース。
VirtualMachineRunCommandScriptSource
timeoutInSeconds
run コマンドを実行するためのタイムアウト (秒単位)。
int
treatFailureAsDeploymentFailure
随意。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみを反映し、スクリプトが失敗した場合にスクリプトが失敗したかどうかを示しません。 executionMessage、output、error: https://aka.ms/runcommandmanaged#get-execution-status-and-results を表示するスクリプトエラーが発生した場合は、run コマンドのインスタンス ビューを参照してください
bool
RunCommandManagedIdentity
名前
形容
価値
clientId
ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。 ObjectId を指定する場合は使用しないでください。
糸
objectId
ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。 これが指定されている場合は、ClientId を使用しないでください。
糸
名前
形容
価値
名前
run コマンド のパラメーター名。
string (必須)
価値
run コマンド パラメーターの値。
string (必須)
VirtualMachineRunCommandScriptSource
名前
形容
価値
commandId
定義済みの組み込みスクリプトの commandId を指定します。
糸
スクリプト
VM で実行するスクリプトコンテンツを指定します。
糸
scriptUri
スクリプトのダウンロード場所を指定します。 読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。
糸
scriptUriManagedIdentity
Azure Storage BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged. を参照してください。
RunCommandManagedIdentity
virtualMachineScaleSets/virtualMachines/runCommands リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
asyncExecution = bool
errorBlobManagedIdentity = {
clientId = "string"
objectId = "string"
}
errorBlobUri = "string"
outputBlobManagedIdentity = {
clientId = "string"
objectId = "string"
}
outputBlobUri = "string"
parameters = [
{
name = "string"
value = "string"
}
]
protectedParameters = [
{
name = "string"
value = "string"
}
]
runAsPassword = "string"
runAsUser = "string"
source = {
commandId = "string"
script = "string"
scriptUri = "string"
scriptUriManagedIdentity = {
clientId = "string"
objectId = "string"
}
}
timeoutInSeconds = int
treatFailureAsDeploymentFailure = bool
}
})
}
プロパティ値
virtualMachineScaleSets/virtualMachines/runCommands
名前
形容
価値
種類
リソースの種類
"Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands@2023-03-01"
名前
リソース名
string (必須)
場所
リソースの場所
string (必須)
parent_id
このリソースの親であるリソースの ID。
種類のリソースの ID: virtualMachines
タグ
リソース タグ
タグ名と値のディクショナリ。
プロパティ
仮想マシンの実行コマンドのプロパティについて説明します。
VirtualMachineRunCommandProperties
VirtualMachineRunCommandProperties
名前
形容
価値
asyncExecution
随意。 true に設定すると、スクリプトが開始されるとすぐにプロビジョニングが完了し、スクリプトが完了するまで待機しません。
bool
errorBlobManagedIdentity
errorBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。
RunCommandManagedIdentity
errorBlobUri
スクリプト エラー ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 errorBlobManagedIdentity パラメーターを参照します。
糸
outputBlobManagedIdentity
outputBlobUri ストレージ BLOB にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 "ストレージ BLOB データ共同作成者" ロールの割り当てを使用して、マネージド ID に BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged を参照してください。
RunCommandManagedIdentity
outputBlobUri
スクリプト出力ストリームをアップロードする Azure Storage BLOB を指定します。 読み取り、追加、作成、書き込みアクセス権を持つ SAS URI を使用するか、マネージド ID を使用して VM に BLOB へのアクセスを提供します。 outputBlobManagedIdentity パラメーターを参照します。
糸
パラメーター
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
protectedParameters
スクリプトで使用されるパラメーター。
RunCommandInputParameter []
runAsPassword
実行コマンドの実行時に VM のユーザー アカウント パスワードを指定します。
糸
runAsUser
実行コマンドの実行時に VM 上のユーザー アカウントを指定します。
糸
源
実行コマンド スクリプトのソース。
VirtualMachineRunCommandScriptSource
timeoutInSeconds
run コマンドを実行するためのタイムアウト (秒単位)。
int
treatFailureAsDeploymentFailure
随意。 true に設定すると、スクリプト内のエラーはデプロイに失敗し、ProvisioningState は Failed としてマークされます。 false に設定すると、ProvisioningState は、実行コマンドが拡張機能プラットフォームによって実行されたかどうかのみを反映し、スクリプトが失敗した場合にスクリプトが失敗したかどうかを示しません。 executionMessage、output、error: https://aka.ms/runcommandmanaged#get-execution-status-and-results を表示するスクリプトエラーが発生した場合は、run コマンドのインスタンス ビューを参照してください
bool
RunCommandManagedIdentity
名前
形容
価値
clientId
ユーザー割り当てマネージド ID のクライアント ID (GUID 値)。 ObjectId を指定する場合は使用しないでください。
糸
objectId
ユーザー割り当てマネージド ID のオブジェクト ID (GUID 値)。 これが指定されている場合は、ClientId を使用しないでください。
糸
名前
形容
価値
名前
run コマンド のパラメーター名。
string (必須)
価値
run コマンド パラメーターの値。
string (必須)
VirtualMachineRunCommandScriptSource
名前
形容
価値
commandId
定義済みの組み込みスクリプトの commandId を指定します。
糸
スクリプト
VM で実行するスクリプトコンテンツを指定します。
糸
scriptUri
スクリプトのダウンロード場所を指定します。 読み取りアクセス権を持つ Azure ストレージ BLOB の SAS URI またはパブリック URI のいずれかを指定できます。
糸
scriptUriManagedIdentity
Azure Storage BLOB の場合に scriptUri にアクセスできるユーザー割り当てマネージド ID。 システム割り当て ID の場合は、空のオブジェクトを使用します。 Azure ストレージ BLOB が存在し、マネージド ID に "ストレージ BLOB データ閲覧者" ロールの割り当てで BLOB のコンテナーへのアクセス権が付与されていることを確認します。 ユーザー割り当て ID の場合は、必ず VM の ID の下に追加してください。 マネージド ID と実行コマンドの詳細については、https://aka.ms/ManagedIdentity と https://aka.ms/RunCommandManaged. を参照してください。
RunCommandManagedIdentity